On Thu, 20 Feb 2025 11:46:46 -0800 SeongJae Park <sj@xxxxxxxxxx> wrote:
> Document {core,ops}_filters directories on usage document.
>
> Signed-off-by: SeongJae Park <sj@xxxxxxxxxx>
> ---
> Documentation/admin-guide/mm/damon/usage.rst | 31 ++++++++++++++------
> 1 file changed, 22 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> index dc37bba96273..4b25c25d4f4f 100644
> --- a/Documentation/admin-guide/mm/damon/usage.rst
> +++ b/Documentation/admin-guide/mm/damon/usage.rst
> @@ -82,7 +82,7 @@ comma (",").
> │ │ │ │ │ │ │ │ :ref:`goals <sysfs_schemes_quota_goals>`/nr_goals
> │ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value
> │ │ │ │ │ │ │ :ref:`watermarks <sysfs_watermarks>`/metric,interval_us,high,mid,low
> - │ │ │ │ │ │ │ :ref:`filters <sysfs_filters>`/nr_filters
> + │ │ │ │ │ │ │ :ref:`{core_,ops_,}filters <sysfs_filters>`/nr_filters
> │ │ │ │ │ │ │ │ 0/type,matching,allow,memcg_path,addr_start,addr_end,target_idx,min,max
> │ │ │ │ │ │ │ :ref:`stats <sysfs_schemes_stats>`/nr_tried,sz_tried,nr_applied,sz_applied,sz_ops_filter_passed,qt_exceeds
> │ │ │ │ │ │ │ :ref:`tried_regions <sysfs_schemes_tried_regions>`/total_bytes
> @@ -282,9 +282,10 @@ to ``N-1``. Each directory represents each DAMON-based operation scheme.
> schemes/<N>/
> ------------
>
> -In each scheme directory, five directories (``access_pattern``, ``quotas``,
> -``watermarks``, ``filters``, ``stats``, and ``tried_regions``) and three files
> -(``action``, ``target_nid`` and ``apply_interval``) exist.
> +In each scheme directory, seven directories (``access_pattern``, ``quotas``,
> +``watermarks``, ``core_filters``, ``ops_filters``, ``filters``, ``stats``, and
> +``tried_regions``) and three files (``action``, ``target_nid`` and
> +``apply_interval``) exist.
>
> The ``action`` file is for setting and getting the scheme's :ref:`action
> <damon_design_damos_action>`. The keywords that can be written to and read
> @@ -395,13 +396,24 @@ The ``interval`` should written in microseconds unit.
>
> .. _sysfs_filters:
>
> -schemes/<N>/filters/
> ---------------------
> +schemes/<N>/{core_,ops_,}filters/
> +-------------------------------
Just found this causes below document build warning and error during 'make
htmldocs':
Documentation/admin-guide/mm/damon/usage.rst:425: WARNING: Title underline too short.
Documentation/admin-guide/mm/damon/usage.rst:425: ERROR: Unknown target name: "core".
I will fix this in the next spin as below.
-schemes/<N>/{core_,ops_,}filters/
--------------------------------
+schemes/<N>/{core\_,ops\_,}filters/
+-----------------------------------
Thanks,
SJ
[...]
