public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/3] docs: kernel-doc: fix stale intel_audio.c path in examples
@ 2026-03-15 15:41 Kit Dallege
  2026-03-15 16:49 ` Randy Dunlap
  0 siblings, 1 reply; 2+ messages in thread
From: Kit Dallege @ 2026-03-15 15:41 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: Shuah Khan, linux-doc, linux-kernel, Kit Dallege, Claude

intel_audio.c was moved from drivers/gpu/drm/i915/ to
drivers/gpu/drm/i915/display/. Update the example paths in the
kernel-doc guide and its Chinese and Italian translations.

Assisted-by: Claude <noreply@anthropic.com>
Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
 Documentation/doc-guide/kernel-doc.rst                    | 4 ++--
 Documentation/translations/it_IT/doc-guide/kernel-doc.rst | 4 ++--
 Documentation/translations/zh_CN/doc-guide/kernel-doc.rst | 4 ++--
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 8d2c09fb36e4..8b579b06ba33 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -550,7 +550,7 @@ internal: *[source-pattern ...]*
 
   Example::
 
-    .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
+    .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
        :internal:
 
 identifiers: *[ function/type ...]*
@@ -588,7 +588,7 @@ doc: *title*
 
   Example::
 
-    .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
+    .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
        :doc: High Definition Audio over HDMI and Display Port
 
 Without options, the kernel-doc directive includes all documentation comments
diff --git a/Documentation/translations/it_IT/doc-guide/kernel-doc.rst b/Documentation/translations/it_IT/doc-guide/kernel-doc.rst
index bac959b8b7b9..cd8bb579d5a2 100644
--- a/Documentation/translations/it_IT/doc-guide/kernel-doc.rst
+++ b/Documentation/translations/it_IT/doc-guide/kernel-doc.rst
@@ -558,7 +558,7 @@ internal: *[source-pattern ...]*
 
   Esempio::
 
-    .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
+    .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
        :internal:
 
 identifiers: *[ function/type ...]*
@@ -587,7 +587,7 @@ doc: *title*
 
   Esempio::
 
-    .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
+    .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
        :doc: High Definition Audio over HDMI and Display Port
 
 Senza alcuna opzione, la direttiva kernel-doc include tutti i commenti di
diff --git a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
index fb2bbaaa85c1..b35f2582cd96 100644
--- a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
+++ b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
@@ -434,7 +434,7 @@ internal: *[source-pattern ...]*
 
   例子::
 
-    .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
+    .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
        :internal:
 
 identifiers: *[ function/type ...]*
@@ -467,7 +467,7 @@ doc: *title*
 
   例子::
 
-    .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
+    .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
        :doc: High Definition Audio over HDMI and Display Port
 
 如果没有选项,kernel-doc指令将包含源文件中的所有文档注释。
-- 
2.53.0


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH 1/3] docs: kernel-doc: fix stale intel_audio.c path in examples
  2026-03-15 15:41 [PATCH 1/3] docs: kernel-doc: fix stale intel_audio.c path in examples Kit Dallege
@ 2026-03-15 16:49 ` Randy Dunlap
  0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2026-03-15 16:49 UTC (permalink / raw)
  To: Kit Dallege, Jonathan Corbet; +Cc: Shuah Khan, linux-doc, linux-kernel, Claude



On 3/15/26 8:41 AM, Kit Dallege wrote:
> intel_audio.c was moved from drivers/gpu/drm/i915/ to
> drivers/gpu/drm/i915/display/. Update the example paths in the
> kernel-doc guide and its Chinese and Italian translations.
> 
> Assisted-by: Claude <noreply@anthropic.com>

All 3 patches in this series use an incorrect Assisted-by: format.
Documentation/process/coding-assistants.rst says:

  Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]

Where:

* ``AGENT_NAME`` is the name of the AI tool or framework
* ``MODEL_VERSION`` is the specific model version used
* ``[TOOL1] [TOOL2]`` are optional specialized analysis tools used
  (e.g., coccinelle, sparse, smatch, clang-tidy)


> Signed-off-by: Kit Dallege <xaum.io@gmail.com>
> ---
>  Documentation/doc-guide/kernel-doc.rst                    | 4 ++--
>  Documentation/translations/it_IT/doc-guide/kernel-doc.rst | 4 ++--
>  Documentation/translations/zh_CN/doc-guide/kernel-doc.rst | 4 ++--
>  3 files changed, 6 insertions(+), 6 deletions(-)


-- 
~Randy


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-03-15 16:49 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-03-15 15:41 [PATCH 1/3] docs: kernel-doc: fix stale intel_audio.c path in examples Kit Dallege
2026-03-15 16:49 ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox