Linux Kernel Mentees list
 help / color / mirror / Atom feed
* [PATCH] kernel-parameters.rst: fix document warnings
@ 2025-08-17 12:22 Bartlomiej Kubik
  2025-08-17 17:18 ` Randy Dunlap
  0 siblings, 1 reply; 2+ messages in thread
From: Bartlomiej Kubik @ 2025-08-17 12:22 UTC (permalink / raw)
  To: corbet; +Cc: skhan, linux-doc, linux-kernel-mentees, rdunlap, Bartlomiej Kubik

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
+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.
-- 
2.39.5


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] kernel-parameters.rst: fix document warnings
  2025-08-17 12:22 [PATCH] kernel-parameters.rst: fix document warnings Bartlomiej Kubik
@ 2025-08-17 17:18 ` Randy Dunlap
  0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2025-08-17 17:18 UTC (permalink / raw)
  To: Bartlomiej Kubik, corbet; +Cc: skhan, linux-doc, linux-kernel-mentees

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


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-08-17 17:18 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-17 12:22 [PATCH] kernel-parameters.rst: fix document warnings Bartlomiej Kubik
2025-08-17 17:18 ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox