docs: hugetlbpage.rst: fix some warnings
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 23 Jun 2020 07:09:06 +0000 (09:09 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 26 Jun 2020 16:01:16 +0000 (10:01 -0600)
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>
Documentation/admin-guide/mm/hugetlbpage.rst

index 5026e58826e2d41203ba2ff564de5297c56846b9..015a5f7d785403549dd9abcdc05a7f923cd34878 100644 (file)
@@ -101,37 +101,48 @@ be specified in bytes with optional scale suffix [kKmMgG].  The default huge
 page size may be selected with the "default_hugepagesz=<size>" boot parameter.
 
 Hugetlb boot command line parameter semantics
-hugepagesz - Specify a huge page size.  Used in conjunction with hugepages
+
+hugepagesz
+       Specify a huge page size.  Used in conjunction with hugepages
        parameter to preallocate a number of huge pages of the specified
        size.  Hence, hugepagesz and hugepages are typically specified in
-       pairs such as:
+       pairs such as::
+
                hugepagesz=2M hugepages=512
+
        hugepagesz can only be specified once on the command line for a
        specific huge page size.  Valid huge page sizes are architecture
        dependent.
-hugepages - Specify the number of huge pages to preallocate.  This typically
+hugepages
+       Specify the number of huge pages to preallocate.  This typically
        follows a valid hugepagesz or default_hugepagesz parameter.  However,
        if hugepages is the first or only hugetlb command line parameter it
        implicitly specifies the number of huge pages of default size to
        allocate.  If the number of huge pages of default size is implicitly
        specified, it can not be overwritten by a hugepagesz,hugepages
        parameter pair for the default size.
-       For example, on an architecture with 2M default huge page size:
+
+       For example, on an architecture with 2M default huge page size::
+
                hugepages=256 hugepagesz=2M hugepages=512
+
        will result in 256 2M huge pages being allocated and a warning message
        indicating that the hugepages=512 parameter is ignored.  If a hugepages
        parameter is preceded by an invalid hugepagesz parameter, it will
        be ignored.
-default_hugepagesz - Specify the default huge page size.  This parameter can
+default_hugepagesz
+       pecify the default huge page size.  This parameter can
        only be specified once on the command line.  default_hugepagesz can
        optionally be followed by the hugepages parameter to preallocate a
        specific number of huge pages of default size.  The number of default
        sized huge pages to preallocate can also be implicitly specified as
        mentioned in the hugepages section above.  Therefore, on an
-       architecture with 2M default huge page size:
+       architecture with 2M default huge page size::
+
                hugepages=256
                default_hugepagesz=2M hugepages=256
                hugepages=256 default_hugepagesz=2M
+
        will all result in 256 2M huge pages being allocated.  Valid default
        huge page size is architecture dependent.