From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Mike Kravetz <mike.kravetz@oracle.com>,
Gerald Schaefer <gerald.schaefer@de.ibm.com>,
Will Deacon <will@kernel.org>,
Andrew Morton <akpm@linux-foundation.org>,
Stephen Rothwell <sfr@canb.auug.org.au>,
linux-mm@kvack.org
Subject: [PATCH v2 10/15] docs: hugetlbpage.rst: fix some warnings
Date: Tue, 23 Jun 2020 09:09:06 +0200 [thread overview]
Message-ID: <86b6796b1a84e18b24314ecd29318951c1479ca2.1592895969.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1592895969.git.mchehab+huawei@kernel.org>
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>
---
Documentation/admin-guide/mm/hugetlbpage.rst | 23 +++++++++++++++-----
1 file changed, 17 insertions(+), 6 deletions(-)
diff --git a/Documentation/admin-guide/mm/hugetlbpage.rst b/Documentation/admin-guide/mm/hugetlbpage.rst
index 5026e58826e2..015a5f7d7854 100644
--- a/Documentation/admin-guide/mm/hugetlbpage.rst
+++ b/Documentation/admin-guide/mm/hugetlbpage.rst
@@ -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.
--
2.26.2
next prev parent reply other threads:[~2020-06-23 7:10 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-23 7:08 [PATCH v2 00/15] Documentation fixes Mauro Carvalho Chehab
2020-06-23 7:08 ` Mauro Carvalho Chehab
2020-06-23 7:08 ` Mauro Carvalho Chehab
2020-06-23 7:08 ` [PATCH v2 01/15] mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter Mauro Carvalho Chehab
2020-06-23 7:08 ` [PATCH v2 02/15] net: dev: add a missing kernel-doc annotation Mauro Carvalho Chehab
2020-06-23 7:08 ` [PATCH v2 03/15] net: netdevice.h: add a description for napi_defer_hard_irqs Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 04/15] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 05/15] net: pylink.h: add kernel-doc descriptions for new fields at phylink_config Mauro Carvalho Chehab
2020-06-23 9:07 ` Russell King - ARM Linux admin
2020-06-23 7:09 ` [PATCH v2 06/15] scripts/kernel-doc: handle function pointer prototypes Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 07/15] fs: fs.h: fix a kernel-doc parameter description Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 08/15] kcsan: fix a kernel-doc warning Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 09/15] selftests/vm/keys: fix a broken reference at protection_keys.c Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab [this message]
2020-06-23 17:38 ` [PATCH v2 10/15] docs: hugetlbpage.rst: fix some warnings Mike Kravetz
2020-06-23 7:09 ` [PATCH v2 11/15] docs: powerpc: fix some issues at vas-api.rst Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 12/15] docs: driver-model: remove a duplicated markup at driver.rst Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 13/15] docs: ABI: fix a typo when pointing to w1-generic.rst Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 14/15] docs: fix references for DMA*.txt files Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab
2020-06-23 7:22 ` Christoph Hellwig
2020-06-23 7:22 ` Christoph Hellwig
2020-06-23 7:22 ` Christoph Hellwig
2020-06-23 7:09 ` [PATCH v2 15/15] docs: fs: proc.rst: convert a new chapter to ReST Mauro Carvalho Chehab
2020-06-26 16:13 ` [PATCH v2 00/15] Documentation fixes Jonathan Corbet
2020-06-26 16:13 ` Jonathan Corbet
2020-06-26 16:13 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86b6796b1a84e18b24314ecd29318951c1479ca2.1592895969.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=gerald.schaefer@de.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mike.kravetz@oracle.com \
--cc=sfr@canb.auug.org.au \
--cc=will@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.