]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
docs/vm: page_owner: convert to ReST format
authorMike Rapoport <rppt@linux.vnet.ibm.com>
Wed, 21 Mar 2018 19:22:35 +0000 (21:22 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 16 Apr 2018 20:18:13 +0000 (14:18 -0600)
Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/vm/page_owner.txt

index ffff1439076a51af81c83e91602c9bfd08bed308..0ed5ab8c7ab46d33d6c37d480b57ce3c23f8d8b7 100644 (file)
@@ -1,7 +1,11 @@
+.. _page_owner:
+
+==================================================
 page owner: Tracking about who allocated each page
------------------------------------------------------------
+==================================================
 
-* Introduction
+Introduction
+============
 
 page owner is for the tracking about who allocated each page.
 It can be used to debug memory leak or to find a memory hogger.
@@ -34,13 +38,15 @@ not affect to allocation performance, especially if the static keys jump
 label patching functionality is available. Following is the kernel's code
 size change due to this facility.
 
-- Without page owner
+- Without page owner::
+
    text    data     bss     dec     hex filename
-  40662    1493     644   42799    a72f mm/page_alloc.o
+   40662   1493     644   42799    a72f mm/page_alloc.o
+
+- With page owner::
 
-- With page owner
    text    data     bss     dec     hex filename
-  40892    1493     644   43029    a815 mm/page_alloc.o
+   40892   1493     644   43029    a815 mm/page_alloc.o
    1427      24       8    1459     5b3 mm/page_ext.o
    2722      50       0    2772     ad4 mm/page_owner.o
 
@@ -62,21 +68,23 @@ are catched and marked, although they are mostly allocated from struct
 page extension feature. Anyway, after that, no page is left in
 un-tracking state.
 
-* Usage
+Usage
+=====
+
+1) Build user-space helper::
 
-1) Build user-space helper
        cd tools/vm
        make page_owner_sort
 
-2) Enable page owner
-       Add "page_owner=on" to boot cmdline.
+2) Enable page owner: add "page_owner=on" to boot cmdline.
 
 3) Do the job what you want to debug
 
-4) Analyze information from page owner
+4) Analyze information from page owner::
+
        cat /sys/kernel/debug/page_owner > page_owner_full.txt
        grep -v ^PFN page_owner_full.txt > page_owner.txt
        ./page_owner_sort page_owner.txt sorted_page_owner.txt
 
-       See the result about who allocated each page
-       in the sorted_page_owner.txt.
+   See the result about who allocated each page
+   in the ``sorted_page_owner.txt``.