Re: [PATCH] Documentation: Fix typo in 'taskstats-struct.rst'
From: Jonathan Corbet
Date: Fri Dec 06 2024 - 11:46:26 EST
Saru2003 <sarvesh20123@xxxxxxxxx> writes:
Thanks for working to improve our documentation. There are a couple of
problems here, though:
> Corrected a typo in the 'taskstats-struct.rst' documentation. The macro name 'TAKSTATS_VERSION' was mistakenly mentioned instead of the correct 'TASKSTATS_VERSION'. The corrected line now accurately references the macro 'TASKSTATS_VERSION', which is defined in '<linux/taskstats.h>'.
Please wrap your changelog lines to a reasonable length. This changelog
is also a bit more verbose than it really needs to be, but that's less
important.
> Signed-off-by: Sarveshwaar SS <sarvesh20123@xxxxxxxxx>
> Signed-off-by: Saru2003 <sarvesh20123@xxxxxxxxx>
You should only sign off the patch once, and the signoff should include
your actual name, please.
> Documentation/accounting/taskstats-struct.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/accounting/taskstats-struct.rst b/Documentation/accounting/taskstats-struct.rst
> index ca90fd489c9a..acca51c34157 100644
> --- a/Documentation/accounting/taskstats-struct.rst
> +++ b/Documentation/accounting/taskstats-struct.rst
> @@ -47,7 +47,7 @@ should not change the relative position of each field within the struct.
> 1) Common and basic accounting fields::
>
> /* The version number of this struct. This field is always set to
> - * TAKSTATS_VERSION, which is defined in <linux/taskstats.h>.
> + * TASKSTATS_VERSION, which is defined in <linux/taskstats.h>.
> * Each time the struct is changed, the value should be incremented.
The change itself is fine.
Thanks,
jon