Skip to content

Commit 82e3fff

Browse files
sjp38torvalds
authored andcommitted
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/[email protected] Signed-off-by: SeongJae Park <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Peter Xu <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
1 parent b5ca3e8 commit 82e3fff

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/admin-guide/mm/damon/start.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ your workload. ::
1919
# mount -t debugfs none /sys/kernel/debug/
2020
# git clone https://github.com/awslabs/damo
2121
# ./damo/damo record $(pidof <your workload>)
22-
# ./damo/damo report heat --plot_ascii
22+
# ./damo/damo report heats --heatmap stdout
2323

2424
The final command draws the access heatmap of ``<your workload>``. The heatmap
2525
shows which memory region (x-axis) is accessed when (y-axis) and how frequently
@@ -94,9 +94,9 @@ Visualizing Recorded Patterns
9494
The following three commands visualize the recorded access patterns and save
9595
the results as separate image files. ::
9696

97-
$ damo report heats --heatmap access_pattern_heatmap.png
98-
$ damo report wss --range 0 101 1 --plot wss_dist.png
99-
$ damo report wss --range 0 101 1 --sortby time --plot wss_chron_change.png
97+
$ sudo damo report heats --heatmap access_pattern_heatmap.png
98+
$ sudo damo report wss --range 0 101 1 --plot wss_dist.png
99+
$ sudo damo report wss --range 0 101 1 --sortby time --plot wss_chron_change.png
100100

101101
- ``access_pattern_heatmap.png`` will visualize the data access pattern in a
102102
heatmap, showing which memory region (y-axis) got accessed when (x-axis)
@@ -115,9 +115,9 @@ Data Access Pattern Aware Memory Management
115115
Below three commands make every memory region of size >=4K that doesn't
116116
accessed for >=60 seconds in your workload to be swapped out. ::
117117

118-
$ echo "#min-size max-size min-acc max-acc min-age max-age action" > scheme
119-
$ echo "4K max 0 0 60s max pageout" >> scheme
120-
$ damo schemes -c my_thp_scheme <pid of your workload>
118+
$ echo "#min-size max-size min-acc max-acc min-age max-age action" > test_scheme
119+
$ echo "4K max 0 0 60s max pageout" >> test_scheme
120+
$ damo schemes -c test_scheme <pid of your workload>
121121

122122
.. [1] https://damonitor.github.io/doc/html/v17/admin-guide/mm/damon/start.html#visualizing-recorded-patterns
123123
.. [2] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html

0 commit comments

Comments
 (0)