[PATCH v2 0/3] docs: assorted documentation fixes

[PATCH v2 0/3] docs: assorted documentation fixes

[Kit Dallege]

Three independent doc fixes: a stale file path in the kernel-doc guide,
misleading wording in sched-stats, and minor grammar issues in the
development process guide.

Changes in v2:
- Fix Assisted-by tag format per Documentation/process/coding-assistants.rst
  (Randy Dunlap)

Kit Dallege (3):
  docs: kernel-doc: fix stale intel_audio.c path in examples
  docs: sched-stats: fix misleading 'per-process' wording
  docs: process: fix grammatical errors in 2.Process.rst

 Documentation/doc-guide/kernel-doc.rst                 |  4 ++--
 Documentation/process/2.Process.rst                    | 10 +++++-----
 Documentation/scheduler/sched-stats.rst                |  4 ++--
 .../translations/it_IT/doc-guide/kernel-doc.rst        |  4 ++--
 .../translations/zh_CN/doc-guide/kernel-doc.rst        |  4 ++--
 5 files changed, 13 insertions(+), 13 deletions(-)

-- 
2.53.0

[PATCH v2 1/3] docs: kernel-doc: fix stale intel_audio.c path in examples

[Kit Dallege]

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:claude-opus-4-6
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

[PATCH v2 2/3] docs: sched-stats: fix misleading 'per-process' wording

[Kit Dallege]

/proc/<pid>/schedstat provides statistics for the specific task (thread)
identified by the pid, not an aggregation across all threads of a
process. Change 'per-process' to 'per-task' to avoid confusion.

Link: https://bugzilla.kernel.org/show_bug.cgi?id=202635
Assisted-by: Claude:claude-opus-4-6
Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
 Documentation/scheduler/sched-stats.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/scheduler/sched-stats.rst b/Documentation/scheduler/sched-stats.rst
index 9d6a337755f4..9187cb6ce1cb 100644
--- a/Documentation/scheduler/sched-stats.rst
+++ b/Documentation/scheduler/sched-stats.rst
@@ -190,8 +190,8 @@ of idleness (busy, idle and newly idle):
 /proc/<pid>/schedstat
 ---------------------
 schedstats also adds a new /proc/<pid>/schedstat file to include some of
-the same information on a per-process level.  There are three fields in
-this file correlating for that process to:
+the same information on a per-task level.  There are three fields in
+this file correlating for that task to:
 
      1) time spent on the cpu (in nanoseconds)
      2) time spent waiting on a runqueue (in nanoseconds)
-- 
2.53.0

Re: [PATCH v2 2/3] docs: sched-stats: fix misleading 'per-process' wording

[Jonathan Corbet]

Kit Dallege <xaum.io@gmail.com> writes:

> /proc/<pid>/schedstat provides statistics for the specific task (thread)
> identified by the pid, not an aggregation across all threads of a
> process. Change 'per-process' to 'per-task' to avoid confusion.
>
> Link: https://bugzilla.kernel.org/show_bug.cgi?id=202635
> Assisted-by: Claude:claude-opus-4-6
> Signed-off-by: Kit Dallege <xaum.io@gmail.com>
> ---
>  Documentation/scheduler/sched-stats.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/scheduler/sched-stats.rst b/Documentation/scheduler/sched-stats.rst
> index 9d6a337755f4..9187cb6ce1cb 100644
> --- a/Documentation/scheduler/sched-stats.rst
> +++ b/Documentation/scheduler/sched-stats.rst
> @@ -190,8 +190,8 @@ of idleness (busy, idle and newly idle):
>  /proc/<pid>/schedstat
>  ---------------------
>  schedstats also adds a new /proc/<pid>/schedstat file to include some of
> -the same information on a per-process level.  There are three fields in
> -this file correlating for that process to:
> +the same information on a per-task level.  There are three fields in
> +this file correlating for that task to:
>  

Until you've copied the scheduler maintainers, a change like this will
not go anywhere useful.

jon

[PATCH v2 3/3] docs: process: fix grammatical errors in 2.Process.rst

[Kit Dallege]

Fix five minor grammatical issues:
- Add comma after introductory phrase "At that point"
- Add comma before conditional "if at all possible"
- Change "close to ready" to "close to being ready"
- Add article "a" before "more extensive review"
- Add article "the" before "volume can reach"

Link: https://bugzilla.kernel.org/show_bug.cgi?id=214931
Assisted-by: Claude:claude-opus-4-6
Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
 Documentation/process/2.Process.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/process/2.Process.rst b/Documentation/process/2.Process.rst
index 57fa8cac58a6..81dddf0c6ace 100644
--- a/Documentation/process/2.Process.rst
+++ b/Documentation/process/2.Process.rst
@@ -63,7 +63,7 @@ As fixes make their way into the mainline, the patch rate will slow over
 time.  Linus releases new -rc kernels about once a week; a normal series
 will get up to somewhere between -rc6 and -rc9 before the kernel is
 considered to be sufficiently stable and the final release is made.
-At that point the whole process starts over again.
+At that point, the whole process starts over again.
 
 As an example, here is how the 5.4 development cycle went (all dates in
 2019):
@@ -156,7 +156,7 @@ The stages that a patch goes through are, generally:
  - Design.  This is where the real requirements for the patch - and the way
    those requirements will be met - are laid out.  Design work is often
    done without involving the community, but it is better to do this work
-   in the open if at all possible; it can save a lot of time redesigning
+   in the open, if at all possible; it can save a lot of time redesigning
    things later.
 
  - Early review.  Patches are posted to the relevant mailing list, and
@@ -164,12 +164,12 @@ The stages that a patch goes through are, generally:
    process should turn up any major problems with a patch if all goes
    well.
 
- - Wider review.  When the patch is getting close to ready for mainline
+ - Wider review.  When the patch is getting close to being ready for mainline
    inclusion, it should be accepted by a relevant subsystem maintainer -
    though this acceptance is not a guarantee that the patch will make it
    all the way to the mainline.  The patch will show up in the maintainer's
    subsystem tree and into the -next trees (described below).  When the
-   process works, this step leads to more extensive review of the patch and
+   process works, this step leads to a more extensive review of the patch and
    the discovery of any problems resulting from the integration of this
    patch with work being done by others.
 
@@ -398,7 +398,7 @@ There are lists hosted elsewhere; please check the MAINTAINERS file for
 the list relevant for any particular subsystem.
 
 The core mailing list for kernel development is, of course, linux-kernel.
-This list is an intimidating place to be; volume can reach 500 messages per
+This list is an intimidating place to be; the volume can reach 500 messages per
 day, the amount of noise is high, the conversation can be severely
 technical, and participants are not always concerned with showing a high
 degree of politeness.  But there is no other place where the kernel
-- 
2.53.0

Re: [PATCH v2 3/3] docs: process: fix grammatical errors in 2.Process.rst

[Jonathan Corbet]

Kit Dallege <xaum.io@gmail.com> writes:

> Fix five minor grammatical issues:
> - Add comma after introductory phrase "At that point"
> - Add comma before conditional "if at all possible"
> - Change "close to ready" to "close to being ready"
> - Add article "a" before "more extensive review"
> - Add article "the" before "volume can reach"
>
> Link: https://bugzilla.kernel.org/show_bug.cgi?id=214931
> Assisted-by: Claude:claude-opus-4-6
> Signed-off-by: Kit Dallege <xaum.io@gmail.com>
> ---
>  Documentation/process/2.Process.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

Honestly, I don't see that any of these constitute an improvement to the
text.

Thanks,

jon