Commit 57f2b54a authored by Shenghong Han's avatar Shenghong Han Committed by Linus Torvalds
Browse files

Documentation/vm/page_owner.rst: update the documentation 

Update the documentation of ``page_owner``.

[akpm@linux-foundation.org: small grammatical tweaks]

Link: https://lkml.kernel.org/r/20211214134736.2569-1-hanshenghong2019@email.szu.edu.cn


Signed-off-by: default avatarShenghong Han <hanshenghong2019@email.szu.edu.cn>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Vlastimil Babka <vbabka@suse.cz>
Cc: Georgi Djakov <georgi.djakov@linaro.org>
Cc: Liam Mark <lmark@codeaurora.org>
Cc: Tang Bin <tangbin@cmss.chinamobile.com>
Cc: Zhang Shengju <zhangshengju@cmss.chinamobile.com>
Cc: Zhenliang Wei <weizhenliang@huawei.com>
Cc: Xiaoming Ni <nixiaoming@huawei.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 41ed6434

Documentation/vm/page_owner.rst

+21 −2
Original line number Diff line number Diff line
@@ -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.