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: <20220429181926.10658-1-hanshenghong2019@email.szu.edu.cn>
Date:   Sat, 30 Apr 2022 02:19:26 +0800
From:   Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
To:     corbet@....net
Cc:     akpm@...ux-foundation.org, akiyks@...il.com, baihaowen@...zu.com,
        seakeel@...il.com, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, caoyixuan2019@...il.szu.edu.cn,
        yejiajian2018@...il.szu.edu.cn, yuhongf@....edu.cn,
        Shenghong Han <hanshenghong2019@...il.szu.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")

---
Thanks Jonathan's suggestion.

This fix is a simpler than before.
And yes, It has built in my machine.

Best,

	Shenghong Han
---
---
 Documentation/vm/page_owner.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
index 25622c715..0ecb4a739 100644
--- a/Documentation/vm/page_owner.rst
+++ b/Documentation/vm/page_owner.rst
@@ -171,11 +171,12 @@ Usage
 
 STANDARD FORMAT SPECIFIERS
 ==========================
-::
 
-For --sort option:
+1) For --sort option.
 
+	====		==========	===========
 	KEY		LONG		DESCRIPTION
+	====		==========	===========
 	p		pid		process ID
 	tg		tgid		thread group ID
 	n		name		task command name
@@ -183,14 +184,18 @@ 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:
+2) 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
+	ator		allocator	memory allocator for pages
+	====		==========	===========
-- 
2.30.1