linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: SeongJae Park <sj@kernel.org>
Cc: SeongJae Park <sj@kernel.org>,
	damon@lists.linux.dev, kernel-team@meta.com,
	linux-kernel@vger.kernel.org, linux-mm@kvack.org
Subject: [RFC PATCH v2 01/10] mm/damon: fixup damos_filter kernel-doc
Date: Fri, 27 Dec 2024 13:08:10 -0800	[thread overview]
Message-ID: <20241227210819.63776-2-sj@kernel.org> (raw)
In-Reply-To: <20241227210819.63776-1-sj@kernel.org>

The comment is slightly wrong.  DAMOS filters are not only for pages,
but general bytes of memory.  Also the description of 'matching' is bit
confusing, since DAMOS filters do only filtering out.  Update the
comments to be less confusing.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 include/linux/damon.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/include/linux/damon.h b/include/linux/damon.h
index 18449b5c45df..15f098372672 100644
--- a/include/linux/damon.h
+++ b/include/linux/damon.h
@@ -347,8 +347,8 @@ enum damos_filter_type {
 
 /**
  * struct damos_filter - DAMOS action target memory filter.
- * @type:	Type of the page.
- * @matching:	If the matching page should filtered out or in.
+ * @type:	Type of the target memory.
+ * @matching:	If the @type-matching memory should be filtered out.
  * @memcg_id:	Memcg id of the question if @type is DAMOS_FILTER_MEMCG.
  * @addr_range:	Address range if @type is DAMOS_FILTER_TYPE_ADDR.
  * @target_idx:	Index of the &struct damon_target of
@@ -357,9 +357,10 @@ enum damos_filter_type {
  * @list:	List head for siblings.
  *
  * Before applying the &damos->action to a memory region, DAMOS checks if each
- * page of the region matches to this and avoid applying the action if so.
- * Support of each filter type depends on the running &struct damon_operations
- * and the type.  Refer to &enum damos_filter_type for more detai.
+ * byte of the region matches to this given condition and avoid applying the
+ * action if so.  Support of each filter type depends on the running &struct
+ * damon_operations and the type.  Refer to &enum damos_filter_type for more
+ * details.
  */
 struct damos_filter {
 	enum damos_filter_type type;
-- 
2.39.5


  reply	other threads:[~2024-12-27 21:08 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-27 21:08 [RFC PATCH v2 00/10] mm/damon: extend DAMOS filters for inclusion of target memory SeongJae Park
2024-12-27 21:08 ` SeongJae Park [this message]
2024-12-27 21:08 ` [RFC PATCH v2 02/10] mm/damon/core: add damos_filter->pass field SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 03/10] mm/damon/core: support damos_filter->pass SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 04/10] mm/damon/paddr: " SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 05/10] mm/damon: add pass argument to damos_new_filter() SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 06/10] mm/damon/sysfs-schemes: add a file for setting damos_filter->pass SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 07/10] Docs/mm/damon/design: document pass/block filters behaviors SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 08/10] Docs/ABI/damon: document DAMOS filter pass sysfs file SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 09/10] Docs/admin-guide/mm/damon/usage: omit DAMOS filter details in favor of design doc SeongJae Park
2024-12-27 21:08 ` [RFC PATCH v2 10/10] Docs/admin-guide/mm/damon/usage: document DAMOS filter 'pass' sysfs file 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=20241227210819.63776-2-sj@kernel.org \
    --to=sj@kernel.org \
    --cc=damon@lists.linux.dev \
    --cc=kernel-team@meta.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox