]> git.baikalelectronics.ru Git - kernel.git/commitdiff
docs: vm/page_owner: tweak literal block in STANDARD FORMAT SPECIFIERS
authorAkira Yokosawa <akiyks@gmail.com>
Fri, 13 May 2022 03:23:07 +0000 (20:23 -0700)
committerAndrew Morton <akpm@linux-foundation.org>
Fri, 13 May 2022 14:20:18 +0000 (07:20 -0700)
A semantic conflict between commit d2590e131918 ("docs: vm/page_owner: use
literal blocks for param description") and a change queued for v5.19
authored by Jiajian Ye ("tools/vm/page_owner_sort.c: support sorting
blocks by multiple keys") results in a warning from "make htmldocs"
saying:

  [...]/vm/page_owner.rst:176: WARNING: Literal block expected; none found.

This is because a literal block in ReST ends at a line which has the same
indent as the paragraph preceding it.  In this case the one with no
indent.

Indent the two "For --xxxx option:" lines by two columns and make the
whole section a literal block.

While at it, fix indents by white spaces of "ator" keys.

Link: https://lkml.kernel.org/r/fdfecc82-d41e-6d8a-738d-4beb6faa27fb@gmail.com
Signed-of-by: Akira Yokosawa <akiyks@gmail.com>
Reported-by: Shenghong Han <hanshenghong2019@email.szu.edu.cn>
Cc: Jiajian Ye <yejiajian2018@email.szu.edu.cn>
Cc: Chongxi Zhao <zhaochongxi2019@email.szu.edu.cn>
Cc: Yinan Zhang <zhangyinan2019@email.szu.edu.cn>
Cc: Yixuan Cao <caoyixuan2019@email.szu.edu.cn>
Cc: Yongqiang Liu <liuyongqiang13@huawei.com>
Cc: Yuhong Feng <yuhongf@szu.edu.cn>
Cc: Haowen Bai <baihaowen@meizu.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Documentation/vm/page_owner.rst

index 25622c715823dcce8b9304445e3de5fada7558c5..f5c954afe97c7473418a0e617b55e00cc4d7b697 100644 (file)
@@ -173,7 +173,7 @@ STANDARD FORMAT SPECIFIERS
 ==========================
 ::
 
-For --sort option:
+  For --sort option:
 
        KEY             LONG            DESCRIPTION
        p               pid             process ID
@@ -183,9 +183,9 @@ For --sort option:
        T               txt             full text of block
        ft              free_ts         timestamp of the page when it was released
        at              alloc_ts        timestamp of the page when it was allocated
-        ator            allocator       memory allocator for pages
+       ator            allocator       memory allocator for pages
 
-For --curl option:
+  For --curl option:
 
        KEY             LONG            DESCRIPTION
        p               pid             process ID
@@ -193,4 +193,4 @@ For --curl option:
        n               name            task command name
        f               free            whether the page has been released or not
        st              stacktrace      stack trace of the page allocation
-        ator            allocator       memory allocator for pages
+       ator            allocator       memory allocator for pages