1. Patchew
  2. linux
  3. View series

[PATCH] Docs/admin-guide/mm/damon/usage: fix the example code snip

Kairui Song posted 1 patch 3 years, 7 months ago
There is a newer version of this series
Documentation/admin-guide/mm/damon/usage.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
[PATCH] Docs/admin-guide/mm/damon/usage: fix the example code snip
Posted by Kairui Song 3 years, 7 months ago 
From: Kairui Song <kasong@tencent.com>

The workflow example code is not working since it got the file names
wrong. So fix this.

Signed-off-by: Kairui Song <kasong@tencent.com>
---
 Documentation/admin-guide/mm/damon/usage.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index d52f572a90298..ca91ecc290785 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -50,10 +50,10 @@ For a short example, users can monitor the virtual address space of a given
 workload as below. ::
 
     # cd /sys/kernel/mm/damon/admin/
-    # echo 1 > kdamonds/nr && echo 1 > kdamonds/0/contexts/nr
+    # echo 1 > kdamonds/nr_kdamonds && echo 1 > kdamonds/0/contexts/nr_contexts
     # echo vaddr > kdamonds/0/contexts/0/operations
-    # echo 1 > kdamonds/0/contexts/0/targets/nr
-    # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid
+    # echo 1 > kdamonds/0/contexts/0/targets/nr_targets
+    # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid_target
     # echo on > kdamonds/0/state
 
 Files Hierarchy
@@ -366,12 +366,12 @@ memory rate becomes larger than 60%, or lower than 30%". ::
     # echo 1 > kdamonds/0/contexts/0/schemes/nr_schemes
     # cd kdamonds/0/contexts/0/schemes/0
     # # set the basic access pattern and the action
-    # echo 4096 > access_patterns/sz/min
-    # echo 8192 > access_patterns/sz/max
-    # echo 0 > access_patterns/nr_accesses/min
-    # echo 5 > access_patterns/nr_accesses/max
-    # echo 10 > access_patterns/age/min
-    # echo 20 > access_patterns/age/max
+    # echo 4096 > access_pattern/sz/min
+    # echo 8192 > access_pattern/sz/max
+    # echo 0 > access_pattern/nr_accesses/min
+    # echo 5 > access_pattern/nr_accesses/max
+    # echo 10 > access_pattern/age/min
+    # echo 20 > access_pattern/age/max
     # echo pageout > action
     # # set quotas
     # echo 10 > quotas/ms
-- 
2.35.2
Re: [PATCH] Docs/admin-guide/mm/damon/usage: fix the example code snip
Posted by SeongJae Park 3 years, 7 months ago 
Hi Kairui,


On Mon, 22 Aug 2022 18:56:17 +0800 Kairui Song <ryncsn@gmail.com> wrote:

> From: Kairui Song <kasong@tencent.com>
> 
> The workflow example code is not working since it got the file names
> wrong. So fix this.

Nice finding, thank you for this patch!

> 
> Signed-off-by: Kairui Song <kasong@tencent.com>

Reviewed-by: SeongJae Park <sj@kernel.org>


Thanks,
SJ

> ---
>  Documentation/admin-guide/mm/damon/usage.rst | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> index d52f572a90298..ca91ecc290785 100644
> --- a/Documentation/admin-guide/mm/damon/usage.rst
> +++ b/Documentation/admin-guide/mm/damon/usage.rst
> @@ -50,10 +50,10 @@ For a short example, users can monitor the virtual address space of a given
>  workload as below. ::
>  
>      # cd /sys/kernel/mm/damon/admin/
> -    # echo 1 > kdamonds/nr && echo 1 > kdamonds/0/contexts/nr
> +    # echo 1 > kdamonds/nr_kdamonds && echo 1 > kdamonds/0/contexts/nr_contexts
>      # echo vaddr > kdamonds/0/contexts/0/operations
> -    # echo 1 > kdamonds/0/contexts/0/targets/nr
> -    # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid
> +    # echo 1 > kdamonds/0/contexts/0/targets/nr_targets
> +    # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid_target
>      # echo on > kdamonds/0/state
>  
>  Files Hierarchy
> @@ -366,12 +366,12 @@ memory rate becomes larger than 60%, or lower than 30%". ::
>      # echo 1 > kdamonds/0/contexts/0/schemes/nr_schemes
>      # cd kdamonds/0/contexts/0/schemes/0
>      # # set the basic access pattern and the action
> -    # echo 4096 > access_patterns/sz/min
> -    # echo 8192 > access_patterns/sz/max
> -    # echo 0 > access_patterns/nr_accesses/min
> -    # echo 5 > access_patterns/nr_accesses/max
> -    # echo 10 > access_patterns/age/min
> -    # echo 20 > access_patterns/age/max
> +    # echo 4096 > access_pattern/sz/min
> +    # echo 8192 > access_pattern/sz/max
> +    # echo 0 > access_pattern/nr_accesses/min
> +    # echo 5 > access_pattern/nr_accesses/max
> +    # echo 10 > access_pattern/age/min
> +    # echo 20 > access_pattern/age/max
>      # echo pageout > action
>      # # set quotas
>      # echo 10 > quotas/ms
> -- 
> 2.35.2
>
Re: [PATCH] Docs/admin-guide/mm/damon/usage: fix the example code snip
Posted by SeongJae Park 3 years, 7 months ago 
On Mon, 22 Aug 2022 16:56:46 +0000 SeongJae Park <sj@kernel.org> wrote:

> Hi Kairui,
> 
> 
> On Mon, 22 Aug 2022 18:56:17 +0800 Kairui Song <ryncsn@gmail.com> wrote:
> 
> > From: Kairui Song <kasong@tencent.com>
> > 
> > The workflow example code is not working since it got the file names
> > wrong. So fix this.
> 
> Nice finding, thank you for this patch!
> 
> > 

Oh, I forgot saying that it would be good to have Fixes: here, like below:

Fixes: b18402726bd1 ("Docs/admin-guide/mm/damon/usage: document DAMON sysfs interface")

I wouldn't say this needs to Cc stable@, as this is just a document example
fix.  Nevertheless, if anyone has a different opinion, please shout out.


Thanks,
SJ

> > Signed-off-by: Kairui Song <kasong@tencent.com>
> 
> Reviewed-by: SeongJae Park <sj@kernel.org>
> 
> 
> Thanks,
> SJ
> 
> > ---
> >  Documentation/admin-guide/mm/damon/usage.rst | 18 +++++++++---------
> >  1 file changed, 9 insertions(+), 9 deletions(-)
> > 
> > diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> > index d52f572a90298..ca91ecc290785 100644
> > --- a/Documentation/admin-guide/mm/damon/usage.rst
> > +++ b/Documentation/admin-guide/mm/damon/usage.rst
> > @@ -50,10 +50,10 @@ For a short example, users can monitor the virtual address space of a given
> >  workload as below. ::
> >  
> >      # cd /sys/kernel/mm/damon/admin/
> > -    # echo 1 > kdamonds/nr && echo 1 > kdamonds/0/contexts/nr
> > +    # echo 1 > kdamonds/nr_kdamonds && echo 1 > kdamonds/0/contexts/nr_contexts
> >      # echo vaddr > kdamonds/0/contexts/0/operations
> > -    # echo 1 > kdamonds/0/contexts/0/targets/nr
> > -    # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid
> > +    # echo 1 > kdamonds/0/contexts/0/targets/nr_targets
> > +    # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid_target
> >      # echo on > kdamonds/0/state
> >  
> >  Files Hierarchy
> > @@ -366,12 +366,12 @@ memory rate becomes larger than 60%, or lower than 30%". ::
> >      # echo 1 > kdamonds/0/contexts/0/schemes/nr_schemes
> >      # cd kdamonds/0/contexts/0/schemes/0
> >      # # set the basic access pattern and the action
> > -    # echo 4096 > access_patterns/sz/min
> > -    # echo 8192 > access_patterns/sz/max
> > -    # echo 0 > access_patterns/nr_accesses/min
> > -    # echo 5 > access_patterns/nr_accesses/max
> > -    # echo 10 > access_patterns/age/min
> > -    # echo 20 > access_patterns/age/max
> > +    # echo 4096 > access_pattern/sz/min
> > +    # echo 8192 > access_pattern/sz/max
> > +    # echo 0 > access_pattern/nr_accesses/min
> > +    # echo 5 > access_pattern/nr_accesses/max
> > +    # echo 10 > access_pattern/age/min
> > +    # echo 20 > access_pattern/age/max
> >      # echo pageout > action
> >      # # set quotas
> >      # echo 10 > quotas/ms
> > -- 
> > 2.35.2
Re: [PATCH] Docs/admin-guide/mm/damon/usage: fix the example code snip
Posted by Kairui Song 3 years, 7 months ago 
SeongJae Park <sj@kernel.org> 于2022年8月23日周二 01:05写道：
>
> On Mon, 22 Aug 2022 16:56:46 +0000 SeongJae Park <sj@kernel.org> wrote:
>
> > Hi Kairui,
> >
> >
> > On Mon, 22 Aug 2022 18:56:17 +0800 Kairui Song <ryncsn@gmail.com> wrote:
> >
> > > From: Kairui Song <kasong@tencent.com>
> > >
> > > The workflow example code is not working since it got the file names
> > > wrong. So fix this.
> >
> > Nice finding, thank you for this patch!
> >
> > >
>
> Oh, I forgot saying that it would be good to have Fixes: here, like below:
>
> Fixes: b18402726bd1 ("Docs/admin-guide/mm/damon/usage: document DAMON sysfs interface")

Thanks for the review, Let me send a V2 adding the "Fixes:" tag and
your review by.

Patchew 2.1-devel-ea86937

© 2016 - 2026 Red Hat, Inc.