tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: hugetlbpage.rst: fix some warnings

Some new command line parameters were added at hugetlbpage.rst.
Adjust them in order to properly parse that part of the file,
avoiding those warnings:

Documentation/admin-guide/mm/hugetlbpage.rst:105: WARNING: Unexpected indentation.
Documentation/admin-guide/mm/hugetlbpage.rst:108: WARNING: Unexpected indentation.
Documentation/admin-guide/mm/hugetlbpage.rst:109: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/admin-guide/mm/hugetlbpage.rst:112: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/admin-guide/mm/hugetlbpage.rst:120: WARNING: Unexpected indentation.
Documentation/admin-guide/mm/hugetlbpage.rst:121: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/admin-guide/mm/hugetlbpage.rst:132: WARNING: Unexpected indentation.
Documentation/admin-guide/mm/hugetlbpage.rst:135: WARNING: Block quote ends without a blank line; unexpected unindent.

Fixes: cd9fa28b5351 ("hugetlbfs: clean up command line processing")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/86b6796b1a84e18b24314ecd29318951c1479ca2.1592895969.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet 72a3e3e2 466fb030

+17 -6
+17 -6
Documentation/admin-guide/mm/hugetlbpage.rst
··· 101 101 page size may be selected with the "default_hugepagesz=<size>" boot parameter. 102 102 103 103 Hugetlb boot command line parameter semantics 104 - hugepagesz - Specify a huge page size. Used in conjunction with hugepages 104 + 105 + hugepagesz 106 + Specify a huge page size. Used in conjunction with hugepages 105 107 parameter to preallocate a number of huge pages of the specified 106 108 size. Hence, hugepagesz and hugepages are typically specified in 107 - pairs such as: 109 + pairs such as:: 110 + 108 111 hugepagesz=2M hugepages=512 112 + 109 113 hugepagesz can only be specified once on the command line for a 110 114 specific huge page size. Valid huge page sizes are architecture 111 115 dependent. 112 - hugepages - Specify the number of huge pages to preallocate. This typically 116 + hugepages 117 + Specify the number of huge pages to preallocate. This typically 113 118 follows a valid hugepagesz or default_hugepagesz parameter. However, 114 119 if hugepages is the first or only hugetlb command line parameter it 115 120 implicitly specifies the number of huge pages of default size to 116 121 allocate. If the number of huge pages of default size is implicitly 117 122 specified, it can not be overwritten by a hugepagesz,hugepages 118 123 parameter pair for the default size. 119 - For example, on an architecture with 2M default huge page size: 124 + 125 + For example, on an architecture with 2M default huge page size:: 126 + 120 127 hugepages=256 hugepagesz=2M hugepages=512 128 + 121 129 will result in 256 2M huge pages being allocated and a warning message 122 130 indicating that the hugepages=512 parameter is ignored. If a hugepages 123 131 parameter is preceded by an invalid hugepagesz parameter, it will 124 132 be ignored. 125 - default_hugepagesz - Specify the default huge page size. This parameter can 133 + default_hugepagesz 134 + pecify the default huge page size. This parameter can 126 135 only be specified once on the command line. default_hugepagesz can 127 136 optionally be followed by the hugepages parameter to preallocate a 128 137 specific number of huge pages of default size. The number of default 129 138 sized huge pages to preallocate can also be implicitly specified as 130 139 mentioned in the hugepages section above. Therefore, on an 131 - architecture with 2M default huge page size: 140 + architecture with 2M default huge page size:: 141 + 132 142 hugepages=256 133 143 default_hugepagesz=2M hugepages=256 134 144 hugepages=256 default_hugepagesz=2M 145 + 135 146 will all result in 256 2M huge pages being allocated. Valid default 136 147 huge page size is architecture dependent. 137 148