linux-kernel - [PATCH] Documentation/vm/page_owner.rst: Fix syntax error and Describe details using table

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-Id: <20220429171844.9673-1-hanshenghong2019@email.szu.edu.cn>
Date:   Sat, 30 Apr 2022 01:18:44 +0800
From:   Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
To:     akpm@...ux-foundation.org
Cc:     corbet@....net, akiyks@...il.com, baihaowen@...zu.com,
        seakeel@...il.com, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org,
        Shenghong Han <hanshenghong2019@...il.szu.edu.cn>,
        Yixuan Cao <caoyixuan2019@...il.szu.edu.cn>,
        Yinan Zhang <zhangyinan2019@...il.szu.edu.cn>,
        Chongxi Zhao <zhaochongxi2019@...il.szu.edu.cn>,
        Jiajian Ye <yejiajian2018@...il.szu.edu.cn>,
        Yuhong Feng <yuhongf@....edu.cn>
Subject: [PATCH] Documentation/vm/page_owner.rst: Fix syntax error and Describe details using table

Some syntax errors exist in "page_owner.rst". Thanks to Akira Yokosawa and
Haowen Bai for tips to help improve the documentation.

We try to fix them. Hope that the Documentation is showed as we expect.

Signed-off-by: Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
Fixes: edc93abbcc6d ("tools/vm/page_owner_sort.c: support sorting blocks by multiple keys")

Co-developed-by: Yixuan Cao <caoyixuan2019@...il.szu.edu.cn>
Co-developed-by: Yinan Zhang <zhangyinan2019@...il.szu.edu.cn>
Co-developed-by: Chongxi Zhao <zhaochongxi2019@...il.szu.edu.cn>
Co-developed-by: Jiajian Ye <yejiajian2018@...il.szu.edu.cn>
Co-developed-by: Yuhong Feng <yuhongf@....edu.cn>
---
Hello Andrew,

In Commit 57f2b54a9379 ("Documentation/vm/page_owner.rst: update the
documentation") and Commit edc93abbcc6d ("tools/vm/page_owner_sort.c:
support sorting blocks by multiple keys"), some incorrect syntax
are used, which laeds to "build warning after merge of the mm tree".
Apologize for that!

This issue is trying to fix it.

Best,

	Shenghong Han
---
---
 Documentation/vm/page_owner.rst | 67 ++++++++++++++++++++++-----------
 1 file changed, 44 insertions(+), 23 deletions(-)

diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
index 25622c715..f900ab99d 100644
--- a/Documentation/vm/page_owner.rst
+++ b/Documentation/vm/page_owner.rst
@@ -171,26 +171,47 @@ Usage
 
 STANDARD FORMAT SPECIFIERS
 ==========================
-::
-
-For --sort option:
-
-	KEY		LONG		DESCRIPTION
-	p		pid		process ID
-	tg		tgid		thread group ID
-	n		name		task command name
-	st		stacktrace	stack trace of the page allocation
-	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
-
-For --curl option:
-
-	KEY		LONG		DESCRIPTION
-	p		pid		process ID
-	tg		tgid		thread group ID
-	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
+
+1) `Table 1`_ for the ``--sort`` option.
+
+.. table:: Table 1
+   :name: Table 1
+
+   +--------+--------------+----------------------------------------------+
+   | KEY    | LONG         | DESCRIPTION                                  |
+   +========+==============+==============================================+
+   | p      | pid          | process ID                                   |
+   +--------+--------------+----------------------------------------------+
+   | tg     | tgid         | thread group ID                              |
+   +--------+--------------+----------------------------------------------+
+   | n      | name         | task command name                            |
+   +--------+--------------+----------------------------------------------+
+   | st     | stacktrace   | stack trace of the page allocation           |
+   +--------+--------------+----------------------------------------------+
+   | 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                   |
+   +--------+--------------+----------------------------------------------+
+
+2) `Table 2`_ for the ``--cull`` option.
+
+.. table:: Table 2
+   :name: Table 2
+
+   +--------+--------------+----------------------------------------------+
+   | KEY    | LONG         | DESCRIPTION                                  |
+   +========+==============+==============================================+
+   | p      | pid          | process ID                                   |
+   +--------+--------------+----------------------------------------------+
+   | tg     | tgid         | thread group ID                              |
+   +--------+--------------+----------------------------------------------+
+   | n      | name         | task command name                            |
+   +--------+--------------+----------------------------------------------+
+   | st     | stacktrace   | stack trace of the page allocation           |
+   +--------+--------------+----------------------------------------------+
+   | ator   | allocator    | memory allocator for pages                   |
+   +--------+--------------+----------------------------------------------+
-- 
2.30.1