[007/114] Documentation/vm/page_owner.rst: update the documentation

Commit Message

Andrew Morton March 25, 2022, 1:08 a.m. UTC

From: Shenghong Han <[e-mail]>
Subject: Documentation/vm/page_owner.rst: update the documentation

Update the documentation of ``page_owner``.

[[e-mail]: small grammatical tweaks]
Link: https://lkml.kernel.org/r/[e-mail]
Signed-off-by: Shenghong Han <[e-mail]>
Cc: Jonathan Corbet <[e-mail]>
Cc: Vlastimil Babka <[e-mail]>
Cc: Georgi Djakov <[e-mail]>
Cc: Liam Mark <[e-mail]>
Cc: Tang Bin <[e-mail]>
Cc: Zhang Shengju <[e-mail]>
Cc: Zhenliang Wei <[e-mail]>
Cc: Xiaoming Ni <[e-mail]>
Signed-off-by: Andrew Morton <[e-mail]>
---

 Documentation/vm/page_owner.rst |   23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

Patch

--- a/Documentation/vm/page_owner.rst~documentation-vm-page_ownerrst-update-the-documentation
+++ a/Documentation/vm/page_owner.rst
@@ -97,7 +97,7 @@  Usage
 
    The ``page_owner_sort`` tool ignores ``PFN`` rows, puts the remaining rows
    in buf, uses regexp to extract the page order value, counts the times
-   and pages of buf, and finally sorts them according to the times.
+   and pages of buf, and finally sorts them according to the parameter(s).
 
    See the result about who allocated each page
    in the ``sorted_page_owner.txt``. General output::
@@ -107,4 +107,23 @@  Usage
 	 // Detailed stack
 
    By default, ``page_owner_sort`` is sorted according to the times of buf.
-   If you want to sort by the pages nums of buf, use the ``-m`` parameter.
+   If you want to sort by the page nums of buf, use the ``-m`` parameter.
+   The detailed parameters are:
+
+   fundamental function:
+
+	Sort:
+		-a		Sort by memory allocation time.
+		-m		Sort by total memory.
+		-p		Sort by pid.
+		-r		Sort by memory release time.
+		-s		Sort by stack trace.
+		-t		Sort by times (default).
+
+   additional function:
+
+	Cull:
+		-c		Cull by comparing stacktrace instead of total block.
+
+	Filter:
+		-f		Filter out the information of blocks whose memory has not been released.