public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: vivekyadav1207731111@gmail.com
Cc: rdunlap@infradead.org, skhan@linuxfoundation.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-doc@vger.kernel.org,
	Vivek Yadav <vivekyadav1207731111@gmail.com>
Subject: Re: [PATCH v3] kernel-parameters: fix kernel-doc warning
Date: Mon, 18 Aug 2025 10:11:27 -0600	[thread overview]
Message-ID: <87wm708v9s.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250816082452.219009-1-vivekyadav1207731111@gmail.com>

vivekyadav1207731111@gmail.com writes:

> From: Vivek Yadav <vivekyadav1207731111@gmail.com>
>
> 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@gmail.com>
> ---
>  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

      reply	other threads:[~2025-08-18 16:11 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-16  8:24 [PATCH v3] kernel-parameters: fix kernel-doc warning vivekyadav1207731111
2025-08-18 16:11 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87wm708v9s.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    --cc=vivekyadav1207731111@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox