[PATCH] docs: kernel-parameters: don't mix cmdline options & build options

[PATCH] docs: kernel-parameters: don't mix cmdline options & build options

[Randy Dunlap]

Some kernel command line descriptions mix, mingle, or conflate an
optional part of the command line with the build options that are
applicable to those command line options.

Specifically, a few command line options that use "KMG" to specify
a memory size mix that string with build options like "X86,EARLY".
These should be separate fields although they are both enclosed in
square brackets, so separate the conflated fields.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org
Cc: linux-mm@kvack.org
Cc: x86@kernel.org

 Documentation/admin-guide/kernel-parameters.txt |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20260930.orig/Documentation/admin-guide/kernel-parameters.txt
+++ linux-next-20260930/Documentation/admin-guide/kernel-parameters.txt
@@ -4080,8 +4080,8 @@ Kernel parameters
 			like Grub2, otherwise '$' and the following number
 			will be eaten.
 
-	memmap=nn[KMG]!ss[KMG,EARLY]
-			[KNL,X86] Mark specific memory as protected.
+	memmap=nn[KMG]!ss[KMG]
+			[KNL,X86,EARLY] Mark specific memory as protected.
 			Region of memory to be used, from ss to ss+nn.
 			The memory region may be marked as e820 type 12 (0xc)
 			and is NVDIMM or ADR memory.
@@ -4371,11 +4371,11 @@ Kernel parameters
 			Enable printing debug information related to MTRR
 			registers at boot time.
 
-	mtrr_chunk_size=nn[KMG,X86,EARLY]
+	mtrr_chunk_size=nn[KMG]		[X86,EARLY]
 			used for mtrr cleanup. It is largest continuous chunk
 			that could hold holes aka. UC entries.
 
-	mtrr_gran_size=nn[KMG,X86,EARLY]
+	mtrr_gran_size=nn[KMG]		[X86,EARLY]
 			Used for mtrr cleanup. It is granularity of mtrr block.
 			Default is 1.
 			Large value could prevent small alignment from

Re: [PATCH] docs: kernel-parameters: don't mix cmdline options & build options

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> Some kernel command line descriptions mix, mingle, or conflate an
> optional part of the command line with the build options that are
> applicable to those command line options.
>
> Specifically, a few command line options that use "KMG" to specify
> a memory size mix that string with build options like "X86,EARLY".
> These should be separate fields although they are both enclosed in
> square brackets, so separate the conflated fields.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-mm@kvack.org
> Cc: x86@kernel.org
>
>  Documentation/admin-guide/kernel-parameters.txt |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> --- linux-next-20260930.orig/Documentation/admin-guide/kernel-parameters.txt
> +++ linux-next-20260930/Documentation/admin-guide/kernel-parameters.txt
> @@ -4080,8 +4080,8 @@ Kernel parameters
>  			like Grub2, otherwise '$' and the following number
>  			will be eaten.
>  
> -	memmap=nn[KMG]!ss[KMG,EARLY]
> -			[KNL,X86] Mark specific memory as protected.
> +	memmap=nn[KMG]!ss[KMG]
> +			[KNL,X86,EARLY] Mark specific memory as protected.
>  			Region of memory to be used, from ss to ss+nn.
>  			The memory region may be marked as e820 type 12 (0xc)
>  			and is NVDIMM or ADR memory.
> @@ -4371,11 +4371,11 @@ Kernel parameters
>  			Enable printing debug information related to MTRR
>  			registers at boot time.
>  
> -	mtrr_chunk_size=nn[KMG,X86,EARLY]
> +	mtrr_chunk_size=nn[KMG]		[X86,EARLY]
>  			used for mtrr cleanup. It is largest continuous chunk
>  			that could hold holes aka. UC entries.
>  
> -	mtrr_gran_size=nn[KMG,X86,EARLY]
> +	mtrr_gran_size=nn[KMG]		[X86,EARLY]
>  			Used for mtrr cleanup. It is granularity of mtrr block.

Applied, thanks.

jon