Linux Kernel Mentees list
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Bartlomiej Kubik <kubik.bartlomiej@gmail.com>, corbet@lwn.net
Cc: skhan@linuxfoundation.org, linux-doc@vger.kernel.org,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH] kernel-parameters.rst: fix document warnings
Date: Sun, 17 Aug 2025 10:18:04 -0700	[thread overview]
Message-ID: <a863e29c-11df-4afa-82f5-bdbe987220c2@infradead.org> (raw)
In-Reply-To: <20250817122244.26590-1-kubik.bartlomiej@gmail.com>

Hi,

On 8/17/25 5:22 AM, Bartlomiej Kubik wrote:
> found/fix two warnings in kernel-parameters.rst.
> 
> -> WARNING: Missing or malformed SPDX-License-Identifier tag in line 1
> -> WARNING: Possible repeated word: 'that'
> 
> command: 
> ./scripts/checkpatch.pl --strict -f Documentation/admin-guide/kernel-parameters.rst
> 
> 
> Signed-off-by: Bartlomiej Kubik <kubik.bartlomiej@gmail.com>
> ---
>  Documentation/admin-guide/kernel-parameters.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.rst b/Documentation/admin-guide/kernel-parameters.rst
> index 39d0e7ff0965..445248787e77 100644
> --- a/Documentation/admin-guide/kernel-parameters.rst
> +++ b/Documentation/admin-guide/kernel-parameters.rst
> @@ -1,3 +1,5 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
>  .. _kernelparameters:
>  
>  The kernel's command-line parameters
> @@ -213,7 +215,7 @@ need or coordination with <Documentation/arch/x86/boot.rst>.
>  There are also arch-specific kernel-parameters not documented here.
>  
>  Note that ALL kernel parameters listed below are CASE SENSITIVE, and that
> -a trailing = on the name of any parameter states that that parameter will

While that may be a little confusing, and it reported as a "Possible repeated
word," I can read it and not see any problem with it.

A satisfactory change IMO would be to say "states that the parameter".

> +a trailing = on the name of any parameter states that parameter will
>  be entered as an environment variable, whereas its absence indicates that
>  it will appear as a kernel argument readable via /proc/cmdline by programs
>  running once the system is up.

-- 
~Randy


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

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-17 12:22 [PATCH] kernel-parameters.rst: fix document warnings Bartlomiej Kubik
2025-08-17 17:18 ` Randy Dunlap [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=a863e29c-11df-4afa-82f5-bdbe987220c2@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=kubik.bartlomiej@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=skhan@linuxfoundation.org \
    /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