[PATCH v2] Documentation/admin-guide: kernel-parameters: update CMA entries

[PATCH v2] Documentation/admin-guide: kernel-parameters: update CMA entries

[Randy Dunlap]

Add qualifying build option legend [CMA] to kernel boot options
that requirce CMA support to be enabled for them to be usable.

Also capitalize 'CMA' when it is used as an acronym.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-mm@kvack.org
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Mike Kravetz <mike.kravetz@oracle.com>
---
v2: rebase & resend

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

--- linux-next-20210122.orig/Documentation/admin-guide/kernel-parameters.txt
+++ linux-next-20210122/Documentation/admin-guide/kernel-parameters.txt
@@ -631,7 +631,7 @@
 			kernel/dma/contiguous.c
 
 	cma_pernuma=nn[MG]
-			[ARM64,KNL]
+			[ARM64,KNL,CMA]
 			Sets the size of kernel per-numa memory area for
 			contiguous memory allocations. A value of 0 disables
 			per-numa CMA altogether. And If this option is not
@@ -1556,12 +1556,12 @@
 	hpet_mmap=	[X86, HPET_MMAP] Allow userspace to mmap HPET
 			registers.  Default set by CONFIG_HPET_MMAP_DEFAULT.
 
-	hugetlb_cma=	[HW] The size of a cma area used for allocation
+	hugetlb_cma=	[HW,CMA] The size of a CMA area used for allocation
 			of gigantic hugepages.
 			Format: nn[KMGTPE]
 
-			Reserve a cma area of given size and allocate gigantic
-			hugepages using the cma allocator. If enabled, the
+			Reserve a CMA area of given size and allocate gigantic
+			hugepages using the CMA allocator. If enabled, the
 			boot-time allocation of gigantic hugepages is skipped.
 
 	hugepages=	[HW] Number of HugeTLB pages to allocate at boot.

Re: [PATCH v2] Documentation/admin-guide: kernel-parameters: update CMA entries

[Mike Kravetz]

On 1/24/21 8:32 PM, Randy Dunlap wrote:
> Add qualifying build option legend [CMA] to kernel boot options
> that requirce CMA support to be enabled for them to be usable.
> 
> Also capitalize 'CMA' when it is used as an acronym.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-mm@kvack.org
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Mike Kravetz <mike.kravetz@oracle.com>
> ---
> v2: rebase & resend
> 
>  Documentation/admin-guide/kernel-parameters.txt |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Thanks,

Acked-by: Mike Kravetz <mike.kravetz@oracle.com>

-- 
Mike Kravetz

> 
> --- linux-next-20210122.orig/Documentation/admin-guide/kernel-parameters.txt
> +++ linux-next-20210122/Documentation/admin-guide/kernel-parameters.txt
> @@ -631,7 +631,7 @@
>  			kernel/dma/contiguous.c
>  
>  	cma_pernuma=nn[MG]
> -			[ARM64,KNL]
> +			[ARM64,KNL,CMA]
>  			Sets the size of kernel per-numa memory area for
>  			contiguous memory allocations. A value of 0 disables
>  			per-numa CMA altogether. And If this option is not
> @@ -1556,12 +1556,12 @@
>  	hpet_mmap=	[X86, HPET_MMAP] Allow userspace to mmap HPET
>  			registers.  Default set by CONFIG_HPET_MMAP_DEFAULT.
>  
> -	hugetlb_cma=	[HW] The size of a cma area used for allocation
> +	hugetlb_cma=	[HW,CMA] The size of a CMA area used for allocation
>  			of gigantic hugepages.
>  			Format: nn[KMGTPE]
>  
> -			Reserve a cma area of given size and allocate gigantic
> -			hugepages using the cma allocator. If enabled, the
> +			Reserve a CMA area of given size and allocate gigantic
> +			hugepages using the CMA allocator. If enabled, the
>  			boot-time allocation of gigantic hugepages is skipped.
>  
>  	hugepages=	[HW] Number of HugeTLB pages to allocate at boot.
> 

Re: [PATCH v2] Documentation/admin-guide: kernel-parameters: update CMA entries

[Jonathan Corbet]

On Sun, 24 Jan 2021 20:32:02 -0800
Randy Dunlap <rdunlap@infradead.org> wrote:

> Add qualifying build option legend [CMA] to kernel boot options
> that requirce CMA support to be enabled for them to be usable.
> 
> Also capitalize 'CMA' when it is used as an acronym.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-mm@kvack.org
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Mike Kravetz <mike.kravetz@oracle.com>
> ---
> v2: rebase & resend
> 
>  Documentation/admin-guide/kernel-parameters.txt |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon