[PATCH] Documentation: taskstats: Reindent payload kinds list

[PATCH] Documentation: taskstats: Reindent payload kinds list

[Bagas Sanjaya]

Payload kinds list text is indented at the first text column, rather
than aligned to the list number. As an effect, the third item becomes
sublist of second item's third sublist item (TASKTYPE_TYPE_STATS).

Reindent the list text.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/accounting/taskstats.rst | 52 +++++++++++++-------------
 1 file changed, 27 insertions(+), 25 deletions(-)

diff --git a/Documentation/accounting/taskstats.rst b/Documentation/accounting/taskstats.rst
index 2a28b7f55c103e..173c1e7bf5efa4 100644
--- a/Documentation/accounting/taskstats.rst
+++ b/Documentation/accounting/taskstats.rst
@@ -76,41 +76,43 @@ The messages are in the format::
 The taskstats payload is one of the following three kinds:
 
 1. Commands: Sent from user to kernel. Commands to get data on
-a pid/tgid consist of one attribute, of type TASKSTATS_CMD_ATTR_PID/TGID,
-containing a u32 pid or tgid in the attribute payload. The pid/tgid denotes
-the task/process for which userspace wants statistics.
+   a pid/tgid consist of one attribute, of type TASKSTATS_CMD_ATTR_PID/TGID,
+   containing a u32 pid or tgid in the attribute payload. The pid/tgid denotes
+   the task/process for which userspace wants statistics.
 
-Commands to register/deregister interest in exit data from a set of cpus
-consist of one attribute, of type
-TASKSTATS_CMD_ATTR_REGISTER/DEREGISTER_CPUMASK and contain a cpumask in the
-attribute payload. The cpumask is specified as an ascii string of
-comma-separated cpu ranges e.g. to listen to exit data from cpus 1,2,3,5,7,8
-the cpumask would be "1-3,5,7-8". If userspace forgets to deregister interest
-in cpus before closing the listening socket, the kernel cleans up its interest
-set over time. However, for the sake of efficiency, an explicit deregistration
-is advisable.
+   Commands to register/deregister interest in exit data from a set of cpus
+   consist of one attribute, of type
+   TASKSTATS_CMD_ATTR_REGISTER/DEREGISTER_CPUMASK and contain a cpumask in the
+   attribute payload. The cpumask is specified as an ascii string of
+   comma-separated cpu ranges e.g. to listen to exit data from cpus 1,2,3,5,7,8
+   the cpumask would be "1-3,5,7-8". If userspace forgets to deregister
+   interest in cpus before closing the listening socket, the kernel cleans up
+   its interest set over time. However, for the sake of efficiency, an explicit
+   deregistration is advisable.
 
 2. Response for a command: sent from the kernel in response to a userspace
-command. The payload is a series of three attributes of type:
+   command. The payload is a series of three attributes of type:
 
-a) TASKSTATS_TYPE_AGGR_PID/TGID : attribute containing no payload but indicates
-a pid/tgid will be followed by some stats.
+   a) TASKSTATS_TYPE_AGGR_PID/TGID: attribute containing no payload but
+      indicates a pid/tgid will be followed by some stats.
 
-b) TASKSTATS_TYPE_PID/TGID: attribute whose payload is the pid/tgid whose stats
-are being returned.
+   b) TASKSTATS_TYPE_PID/TGID: attribute whose payload is the pid/tgid whose
+      stats are being returned.
 
-c) TASKSTATS_TYPE_STATS: attribute with a struct taskstats as payload. The
-same structure is used for both per-pid and per-tgid stats.
+   c) TASKSTATS_TYPE_STATS: attribute with a struct taskstats as payload. The
+      same structure is used for both per-pid and per-tgid stats.
 
 3. New message sent by kernel whenever a task exits. The payload consists of a
    series of attributes of the following type:
 
-a) TASKSTATS_TYPE_AGGR_PID: indicates next two attributes will be pid+stats
-b) TASKSTATS_TYPE_PID: contains exiting task's pid
-c) TASKSTATS_TYPE_STATS: contains the exiting task's per-pid stats
-d) TASKSTATS_TYPE_AGGR_TGID: indicates next two attributes will be tgid+stats
-e) TASKSTATS_TYPE_TGID: contains tgid of process to which task belongs
-f) TASKSTATS_TYPE_STATS: contains the per-tgid stats for exiting task's process
+   a) TASKSTATS_TYPE_AGGR_PID: indicates next two attributes will be pid+stats
+   b) TASKSTATS_TYPE_PID: contains exiting task's pid
+   c) TASKSTATS_TYPE_STATS: contains the exiting task's per-pid stats
+   d) TASKSTATS_TYPE_AGGR_TGID: indicates next two attributes will be
+      tgid+stats
+   e) TASKSTATS_TYPE_TGID: contains tgid of process to which task belongs
+   f) TASKSTATS_TYPE_STATS: contains the per-tgid stats for exiting task's
+      process
 
 
 per-tgid stats

base-commit: 27600b51fbc8b9a4eba18c8d88d7edb146605f3f
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: taskstats: Reindent payload kinds list

[Randy Dunlap]

On 11/4/25 5:07 AM, Bagas Sanjaya wrote:
> Payload kinds list text is indented at the first text column, rather
> than aligned to the list number. As an effect, the third item becomes
> sublist of second item's third sublist item (TASKTYPE_TYPE_STATS).
> 
> Reindent the list text.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  Documentation/accounting/taskstats.rst | 52 +++++++++++++-------------
>  1 file changed, 27 insertions(+), 25 deletions(-)
> 
> diff --git a/Documentation/accounting/taskstats.rst b/Documentation/accounting/taskstats.rst
> index 2a28b7f55c103e..173c1e7bf5efa4 100644
> --- a/Documentation/accounting/taskstats.rst
> +++ b/Documentation/accounting/taskstats.rst
> @@ -76,41 +76,43 @@ The messages are in the format::
>  The taskstats payload is one of the following three kinds:
>  
>  1. Commands: Sent from user to kernel. Commands to get data on
> -a pid/tgid consist of one attribute, of type TASKSTATS_CMD_ATTR_PID/TGID,
> -containing a u32 pid or tgid in the attribute payload. The pid/tgid denotes
> -the task/process for which userspace wants statistics.
> +   a pid/tgid consist of one attribute, of type TASKSTATS_CMD_ATTR_PID/TGID,
> +   containing a u32 pid or tgid in the attribute payload. The pid/tgid denotes
> +   the task/process for which userspace wants statistics.
>  
> -Commands to register/deregister interest in exit data from a set of cpus
> -consist of one attribute, of type
> -TASKSTATS_CMD_ATTR_REGISTER/DEREGISTER_CPUMASK and contain a cpumask in the
> -attribute payload. The cpumask is specified as an ascii string of
> -comma-separated cpu ranges e.g. to listen to exit data from cpus 1,2,3,5,7,8
> -the cpumask would be "1-3,5,7-8". If userspace forgets to deregister interest
> -in cpus before closing the listening socket, the kernel cleans up its interest
> -set over time. However, for the sake of efficiency, an explicit deregistration
> -is advisable.
> +   Commands to register/deregister interest in exit data from a set of cpus
> +   consist of one attribute, of type
> +   TASKSTATS_CMD_ATTR_REGISTER/DEREGISTER_CPUMASK and contain a cpumask in the
> +   attribute payload. The cpumask is specified as an ascii string of
> +   comma-separated cpu ranges e.g. to listen to exit data from cpus 1,2,3,5,7,8
> +   the cpumask would be "1-3,5,7-8". If userspace forgets to deregister
> +   interest in cpus before closing the listening socket, the kernel cleans up
> +   its interest set over time. However, for the sake of efficiency, an explicit
> +   deregistration is advisable.
>  
>  2. Response for a command: sent from the kernel in response to a userspace
> -command. The payload is a series of three attributes of type:
> +   command. The payload is a series of three attributes of type:
>  
> -a) TASKSTATS_TYPE_AGGR_PID/TGID : attribute containing no payload but indicates
> -a pid/tgid will be followed by some stats.
> +   a) TASKSTATS_TYPE_AGGR_PID/TGID: attribute containing no payload but
> +      indicates a pid/tgid will be followed by some stats.
>  
> -b) TASKSTATS_TYPE_PID/TGID: attribute whose payload is the pid/tgid whose stats
> -are being returned.
> +   b) TASKSTATS_TYPE_PID/TGID: attribute whose payload is the pid/tgid whose
> +      stats are being returned.
>  
> -c) TASKSTATS_TYPE_STATS: attribute with a struct taskstats as payload. The
> -same structure is used for both per-pid and per-tgid stats.
> +   c) TASKSTATS_TYPE_STATS: attribute with a struct taskstats as payload. The
> +      same structure is used for both per-pid and per-tgid stats.
>  
>  3. New message sent by kernel whenever a task exits. The payload consists of a
>     series of attributes of the following type:
>  
> -a) TASKSTATS_TYPE_AGGR_PID: indicates next two attributes will be pid+stats
> -b) TASKSTATS_TYPE_PID: contains exiting task's pid
> -c) TASKSTATS_TYPE_STATS: contains the exiting task's per-pid stats
> -d) TASKSTATS_TYPE_AGGR_TGID: indicates next two attributes will be tgid+stats
> -e) TASKSTATS_TYPE_TGID: contains tgid of process to which task belongs
> -f) TASKSTATS_TYPE_STATS: contains the per-tgid stats for exiting task's process
> +   a) TASKSTATS_TYPE_AGGR_PID: indicates next two attributes will be pid+stats
> +   b) TASKSTATS_TYPE_PID: contains exiting task's pid
> +   c) TASKSTATS_TYPE_STATS: contains the exiting task's per-pid stats
> +   d) TASKSTATS_TYPE_AGGR_TGID: indicates next two attributes will be
> +      tgid+stats
> +   e) TASKSTATS_TYPE_TGID: contains tgid of process to which task belongs
> +   f) TASKSTATS_TYPE_STATS: contains the per-tgid stats for exiting task's
> +      process
>  
>  
>  per-tgid stats
> 
> base-commit: 27600b51fbc8b9a4eba18c8d88d7edb146605f3f

-- 
~Randy

Re: [PATCH] Documentation: taskstats: Reindent payload kinds list

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Payload kinds list text is indented at the first text column, rather
> than aligned to the list number. As an effect, the third item becomes
> sublist of second item's third sublist item (TASKTYPE_TYPE_STATS).
>
> Reindent the list text.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/accounting/taskstats.rst | 52 +++++++++++++-------------
>  1 file changed, 27 insertions(+), 25 deletions(-)

Applied, thanks.

jon