Re: [PATCH v3] kernel-parameters: fix kernel-doc warning

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



vivekyadav1207731111@xxxxxxxxx writes:

> From: Vivek Yadav <vivekyadav1207731111@xxxxxxxxx>
>
> Fix kernel-doc warning in kernel-parameters.txt
>
> WARNING: Possible repeated word: 'is'
>
> ```
> [command]
> ./scripts/checkpatch.pl --strict -f Documentation/admin-guide/kernel-parameters.txt
>
> [output]
> WARNING: Possible repeated word: 'is'
> +            The format is is "trace_trigger=<event>.<trigger>[ if <filter>],..."
>
> total: 0 errors, 1 warnings, 0 checks, 8339 lines checked
> ```
>
> Signed-off-by: Vivek Yadav <vivekyadav1207731111@xxxxxxxxx>
> ---
>  Documentation/admin-guide/kernel-parameters.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 747a55abf..302145870 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -7506,7 +7506,7 @@
>  			Set a trigger on top of a specific event, with an optional
>  			filter.
>  
> -			The format is is "trace_trigger=<event>.<trigger>[ if <filter>],..."
> +			The format is "trace_trigger=<event>.<trigger>[ if <filter>],..."

I have applied this, thanks.

For future reference, "fix a warning" is seldom a good subject-line
choice.  Warnings are not problems, errors are.  In this case, a proper
subject would be "docs: remove a duplicated word from
kernel-parameters.txt".

Thanks,

jon




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux