[PATCH] proc.5: PID/stat: add I, fix P state doc

[PATCH] proc.5: PID/stat: add I, fix P state doc

[Kir Kolyshkin]

1. The I state was not documented -- add it.

2. The P state was documented to be absent since Linux 3.13.
   It appears it has been reintroduced in Linux 4.14. Document
   it, and move the description up (so that currently present
   states will be above the ones that got removed).

3. Consolidate the two descriptions of W state.

This way, the set of states documented matches those that are present
as of Linux v5.14-rc4 ("RSDTtXZPI").

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 man5/proc.5 | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/man5/proc.5 b/man5/proc.5
index 69f6e15dd..d6027c469 100644
--- a/man5/proc.5
+++ b/man5/proc.5
@@ -2099,10 +2099,18 @@ Stopped (on a signal) or (before Linux 2.6.33) trace stopped
 .IP t
 .\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29
 Tracing stop (Linux 2.6.33 onward)
-.IP W
-Paging (only before Linux 2.6.0)
 .IP X
 Dead (from Linux 2.6.0 onward)
+.IP I
+.\" commit 06eb61844d841d0032a9950ce7f8e783ee49c0d0
+Idle kernel thread (Linux 4.14 onward)
+.IP P
+.\" commit f2530dc71cf0822f90bb63ea4600caaef33a66bb
+Parked (Linux 3.9 to
+.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
+3.13,
+.\" commit 8ef9925b02c23e3838d5e593c5cf37984141150f
+from 4.14 onwards)
 .IP x
 .\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29
 Dead (Linux 2.6.33 to
@@ -2117,12 +2125,7 @@ Wakekill (Linux 2.6.33 to
 .\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29
 Waking (Linux 2.6.33 to
 .\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
-3.13 only)
-.IP P
-.\" commit f2530dc71cf0822f90bb63ea4600caaef33a66bb
-Parked (Linux 3.9 to
-.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
-3.13 only)
+3.13 only) or (before Linux 2.6.0) paging
 .RE
 .TP
 (4) \fIppid\fP \ %d
-- 
2.32.0

Re: [PATCH] proc.5: PID/stat: add I, fix P state doc

[Alejandro Colomar (man-pages)]

Hi Kir,

On 8/4/21 4:15 AM, Kir Kolyshkin wrote:
> 1. The I state was not documented -- add it.
> 
> 2. The P state was documented to be absent since Linux 3.13.
>     It appears it has been reintroduced in Linux 4.14. Document
>     it, and move the description up (so that currently present
>     states will be above the ones that got removed).
> 
> 3. Consolidate the two descriptions of W state.
> 
> This way, the set of states documented matches those that are present
> as of Linux v5.14-rc4 ("RSDTtXZPI").
> 
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>

Thanks for the patch!  Please see a few minor comments below.

Thanks,

Alex

> ---
>   man5/proc.5 | 19 +++++++++++--------
>   1 file changed, 11 insertions(+), 8 deletions(-)
> 
> diff --git a/man5/proc.5 b/man5/proc.5
> index 69f6e15dd..d6027c469 100644
> --- a/man5/proc.5
> +++ b/man5/proc.5
> @@ -2099,10 +2099,18 @@ Stopped (on a signal) or (before Linux 2.6.33) trace stopped
>   .IP t
>   .\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29
>   Tracing stop (Linux 2.6.33 onward)
> -.IP W
> -Paging (only before Linux 2.6.0)
>   .IP X
>   Dead (from Linux 2.6.0 onward)
> +.IP I
> +.\" commit 06eb61844d841d0032a9950ce7f8e783ee49c0d0
> +Idle kernel thread (Linux 4.14 onward)
> +.IP P
> +.\" commit f2530dc71cf0822f90bb63ea4600caaef33a66bb
> +Parked (Linux 3.9 to
> +.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
> +3.13,
> +.\" commit 8ef9925b02c23e3838d5e593c5cf37984141150f
> +from 4.14 onwards)

s/onwards/onward/

I'd add an "and" before "from", or change s/,/;/

>   .IP x
>   .\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29
>   Dead (Linux 2.6.33 to
> @@ -2117,12 +2125,7 @@ Wakekill (Linux 2.6.33 to
>   .\" commit 44d90df6b757c59651ddd55f1a84f28132b50d29
>   Waking (Linux 2.6.33 to
>   .\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
> -3.13 only)
> -.IP P
> -.\" commit f2530dc71cf0822f90bb63ea4600caaef33a66bb
> -Parked (Linux 3.9 to
> -.\" commit 74e37200de8e9c4e09b70c21c3f13c2071e77457
> -3.13 only)
> +3.13 only) or (before Linux 2.6.0) paging
>   .RE
>   .TP
>   (4) \fIppid\fP \ %d
> 


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/