Skip to content

Commit 12e4d4b

Browse files
Zenghui Yuakpm00
authored andcommitted
Docs/{ABI,admin-guide}/damon: fix various typoes
``damon_target_idx`` was wrongly written as ``target_idx`` in the docs. Fix it all over the place, as well as the wrong directory count, grammar, etc. Link: https://lore.kernel.org/20260520012104.93602-4-sj@kernel.org Signed-off-by: SeongJae Park <sj@kernel.org> Signed-off-by: Zenghui Yu <zenghui.yu@linux.dev> Reviewed-by: SeongJae Park <sj@kernel.org> Cc: David Hildenbrand <david@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Liam R. Howlett <liam@infradead.org> Cc: Lorenzo Stoakes <ljs@kernel.org> Cc: Michal Hocko <mhocko@suse.com> Cc: Mike Rapoport (Microsoft) <rppt@kernel.org> Cc: niecheng <niecheng1@uniontech.com> Cc: Sakurai Shun <ssh1326@icloud.com> Cc: Shuah Khan <skhan@linuxfoundation.org> Cc: Suren Baghdasaryan <surenb@google.com> Cc: Vlastimil Babka <vbabka@kernel.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
1 parent de5480a commit 12e4d4b

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

Documentation/ABI/testing/sysfs-kernel-mm-damon

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ Description: If 'hugepage_size' is written to the 'type' file, writing to
452452
or reading from this file sets or gets the maximum size of the
453453
hugepage for the filter.
454454

455-
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/core_filters/<F>/target_idx
455+
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/core_filters/<F>/damon_target_idx
456456
Date: Feb 2025
457457
Contact: SeongJae Park <sj@kernel.org>
458458
Description: If 'target' is written to the 'type' file, writing to or

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ comma (",").
9797
│ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value,nid,path
9898
│ │ │ │ │ │ │ :ref:`watermarks <sysfs_watermarks>`/metric,interval_us,high,mid,low
9999
│ │ │ │ │ │ │ :ref:`{core_,ops_,}filters <sysfs_filters>`/nr_filters
100-
│ │ │ │ │ │ │ │ 0/type,matching,allow,memcg_path,addr_start,addr_end,target_idx,min,max
100+
│ │ │ │ │ │ │ │ 0/type,matching,allow,memcg_path,addr_start,addr_end,damon_target_idx,min,max
101101
│ │ │ │ │ │ │ :ref:`dests <damon_sysfs_dests>`/nr_dests
102102
│ │ │ │ │ │ │ │ 0/id,weight
103103
│ │ │ │ │ │ │ :ref:`stats <sysfs_schemes_stats>`/nr_tried,sz_tried,nr_applied,sz_applied,sz_ops_filter_passed,qt_exceeds,nr_snapshots,max_nr_snapshots
@@ -374,7 +374,7 @@ to ``N-1``. Each directory represents each DAMON-based operation scheme.
374374
schemes/<N>/
375375
------------
376376

377-
In each scheme directory, eight directories (``access_pattern``, ``quotas``,
377+
In each scheme directory, nine directories (``access_pattern``, ``quotas``,
378378
``watermarks``, ``core_filters``, ``ops_filters``, ``filters``, ``dests``,
379379
``stats``, and ``tried_regions``) and three files (``action``, ``target_nid``
380380
and ``apply_interval``) exist.
@@ -492,15 +492,15 @@ given DAMON-based operation scheme.
492492
Under the watermarks directory, five files (``metric``, ``interval_us``,
493493
``high``, ``mid``, and ``low``) for setting the metric, the time interval
494494
between check of the metric, and the three watermarks exist. You can set and
495-
get the five values by writing to the files, respectively.
495+
get the five values by writing to and reading from the files, respectively.
496496

497497
Keywords and meanings of those that can be written to the ``metric`` file are
498498
as below.
499499

500500
- none: Ignore the watermarks
501501
- free_mem_rate: System's free memory rate (per thousand)
502502

503-
The ``interval`` should written in microseconds unit.
503+
The ``interval_us`` should be written in microseconds unit.
504504

505505
.. _sysfs_filters:
506506

@@ -528,9 +528,9 @@ in the numeric order.
528528

529529
Each filter directory contains nine files, namely ``type``, ``matching``,
530530
``allow``, ``memcg_path``, ``addr_start``, ``addr_end``, ``min``, ``max``
531-
and ``target_idx``. To ``type`` file, you can write the type of the filter.
532-
Refer to :ref:`the design doc <damon_design_damos_filters>` for available type
533-
names, their meaning and on what layer those are handled.
531+
and ``damon_target_idx``. To ``type`` file, you can write the type of the
532+
filter. Refer to :ref:`the design doc <damon_design_damos_filters>` for
533+
available type names, their meaning and on what layer those are handled.
534534

535535
For ``memcg`` type, you can specify the memory cgroup of the interest by
536536
writing the path of the memory cgroup from the cgroups mount point to
@@ -540,7 +540,7 @@ files, respectively. For ``hugepage_size`` type, you can specify the minimum
540540
and maximum size of the range (closed interval) to ``min`` and ``max`` files,
541541
respectively. For ``target`` type, you can specify the index of the target
542542
between the list of the DAMON context's monitoring targets list to
543-
``target_idx`` file.
543+
``damon_target_idx`` file.
544544

545545
You can write ``Y`` or ``N`` to ``matching`` file to specify whether the filter
546546
is for memory that matches the ``type``. You can write ``Y`` or ``N`` to
@@ -731,7 +731,7 @@ show results using tracepoint supporting tools like ``perf``. For example::
731731

732732
Each line of the perf script output represents each monitoring region. The
733733
first five fields are as usual other tracepoint outputs. The sixth field
734-
(``target_id=X``) shows the ide of the monitoring target of the region. The
734+
(``target_id=X``) shows the id of the monitoring target of the region. The
735735
seventh field (``nr_regions=X``) shows the total number of monitoring regions
736736
for the target. The eighth field (``X-Y:``) shows the start (``X``) and end
737737
(``Y``) addresses of the region in bytes. The ninth field (``X``) shows the

0 commit comments

Comments
 (0)