Commit 82e3fff5 authored by SeongJae Park's avatar SeongJae Park Committed by Linus Torvalds

Docs/admin-guide/mm/damon/start: fix wrong example commands

Patch series "Fix trivial nits in Documentation/admin-guide/mm".

This patchset fixes trivial nits in admin guide documents for DAMON and
pagemap.

This patch (of 4):

Some of the example commands in DAMON getting started guide are
outdated, missing sudo, or just wrong.  This fixes those.

Link: https://lkml.kernel.org/r/20211022090311.3856-2-sj@kernel.orgSigned-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Peter Xu <peterx@redhat.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent b5ca3e83
...@@ -19,7 +19,7 @@ your workload. :: ...@@ -19,7 +19,7 @@ your workload. ::
# mount -t debugfs none /sys/kernel/debug/ # mount -t debugfs none /sys/kernel/debug/
# git clone https://github.com/awslabs/damo # git clone https://github.com/awslabs/damo
# ./damo/damo record $(pidof <your workload>) # ./damo/damo record $(pidof <your workload>)
# ./damo/damo report heat --plot_ascii # ./damo/damo report heats --heatmap stdout
The final command draws the access heatmap of ``<your workload>``. The heatmap The final command draws the access heatmap of ``<your workload>``. The heatmap
shows which memory region (x-axis) is accessed when (y-axis) and how frequently shows which memory region (x-axis) is accessed when (y-axis) and how frequently
...@@ -94,9 +94,9 @@ Visualizing Recorded Patterns ...@@ -94,9 +94,9 @@ Visualizing Recorded Patterns
The following three commands visualize the recorded access patterns and save The following three commands visualize the recorded access patterns and save
the results as separate image files. :: the results as separate image files. ::
$ damo report heats --heatmap access_pattern_heatmap.png $ sudo damo report heats --heatmap access_pattern_heatmap.png
$ damo report wss --range 0 101 1 --plot wss_dist.png $ sudo damo report wss --range 0 101 1 --plot wss_dist.png
$ damo report wss --range 0 101 1 --sortby time --plot wss_chron_change.png $ sudo damo report wss --range 0 101 1 --sortby time --plot wss_chron_change.png
- ``access_pattern_heatmap.png`` will visualize the data access pattern in a - ``access_pattern_heatmap.png`` will visualize the data access pattern in a
heatmap, showing which memory region (y-axis) got accessed when (x-axis) heatmap, showing which memory region (y-axis) got accessed when (x-axis)
...@@ -115,9 +115,9 @@ Data Access Pattern Aware Memory Management ...@@ -115,9 +115,9 @@ Data Access Pattern Aware Memory Management
Below three commands make every memory region of size >=4K that doesn't Below three commands make every memory region of size >=4K that doesn't
accessed for >=60 seconds in your workload to be swapped out. :: accessed for >=60 seconds in your workload to be swapped out. ::
$ echo "#min-size max-size min-acc max-acc min-age max-age action" > scheme $ echo "#min-size max-size min-acc max-acc min-age max-age action" > test_scheme
$ echo "4K max 0 0 60s max pageout" >> scheme $ echo "4K max 0 0 60s max pageout" >> test_scheme
$ damo schemes -c my_thp_scheme <pid of your workload> $ damo schemes -c test_scheme <pid of your workload>
.. [1] https://damonitor.github.io/doc/html/v17/admin-guide/mm/damon/start.html#visualizing-recorded-patterns .. [1] https://damonitor.github.io/doc/html/v17/admin-guide/mm/damon/start.html#visualizing-recorded-patterns
.. [2] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html .. [2] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment