From: SeongJae Park <sj@kernel.org>
To: akpm@linux-foundation.org, corbet@lwn.net
Cc: peterx@redhat.com, linux-mm@kvack.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, SeongJae Park <sj@kernel.org>
Subject: [PATCH 1/4] Docs/admin-guide/mm/damon/start: Fix wrong example commands
Date: Fri, 22 Oct 2021 09:03:08 +0000 [thread overview]
Message-ID: <20211022090311.3856-2-sj@kernel.org> (raw)
In-Reply-To: <20211022090311.3856-1-sj@kernel.org>
Some of the example commands in DAMON getting started guide are
outdated, missing sudo, or just wrong. This commit fixes those.
Signed-off-by: SeongJae Park <sj@kernel.org>
---
Documentation/admin-guide/mm/damon/start.rst | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/admin-guide/mm/damon/start.rst b/Documentation/admin-guide/mm/damon/start.rst
index 51503cf90ca2..3ad8bbed9b18 100644
--- a/Documentation/admin-guide/mm/damon/start.rst
+++ b/Documentation/admin-guide/mm/damon/start.rst
@@ -19,7 +19,7 @@ your workload. ::
# mount -t debugfs none /sys/kernel/debug/
# git clone https://github.com/awslabs/damo
# ./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
shows which memory region (x-axis) is accessed when (y-axis) and how frequently
@@ -94,9 +94,9 @@ Visualizing Recorded Patterns
The following three commands visualize the recorded access patterns and save
the results as separate image files. ::
- $ damo report heats --heatmap access_pattern_heatmap.png
- $ 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 heats --heatmap access_pattern_heatmap.png
+ $ sudo damo report wss --range 0 101 1 --plot wss_dist.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
heatmap, showing which memory region (y-axis) got accessed when (x-axis)
@@ -115,9 +115,9 @@ Data Access Pattern Aware Memory Management
Below three commands make every memory region of size >=4K that doesn't
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 "4K max 0 0 60s max pageout" >> scheme
- $ damo schemes -c my_thp_scheme <pid of your workload>
+ $ echo "#min-size max-size min-acc max-acc min-age max-age action" > test_scheme
+ $ echo "4K max 0 0 60s max pageout" >> test_scheme
+ $ 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
.. [2] https://damonitor.github.io/test/result/visual/latest/rec.heatmap.1.png.html
--
2.17.1
next prev parent reply other threads:[~2021-10-22 9:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-22 9:03 [PATCH 0/4] Fix trivial nits in Documentation/admin-guide/mm SeongJae Park
2021-10-22 9:03 ` SeongJae Park [this message]
2021-10-22 9:03 ` [PATCH 2/4] Docs/admin-guide/mm/damon/start: Fix a wrong link SeongJae Park
2021-10-22 9:03 ` [PATCH 3/4] Docs/admin-guide/mm/damon/start: Simplify the content SeongJae Park
2021-10-22 9:03 ` [PATCH 4/4] Docs/admin-guide/mm/pagemap: Wordsmith page flags descriptions SeongJae Park
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211022090311.3856-2-sj@kernel.org \
--to=sj@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=peterx@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.