From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wm1-f46.google.com (mail-wm1-f46.google.com [209.85.128.46]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 004CF35AC07 for ; Tue, 9 Jun 2026 14:34:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.46 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1781015700; cv=none; b=A3ihI3cc8n9UnMeKzMV1vcYD7psoxjICk16C3HnRAUIc65LUaSX6g5H/CoXLH5M2oskEyzND44Kd9/OabNDHSm/zApv+RgpVfEn6ZIWdJhwVFhongTYvtpnURMbCEna1HWSa4F9vvECzZN5Ix2d11ZNgSIcgeA+AabFqQVAoVSw= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1781015700; c=relaxed/simple; bh=pnHV3Ye+jcw8HhYnQc+Fnxg3Gl5lWmUXPzdc9v3HAMY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=l/Qr3PG06i4SCUvIQMK3n7pcqEQa4vpBBwZEl+hOs1Dx9Uyp/BLiSLJo2sK1gK7WyS6B0kWURBwrhLUh/uALbeBXVZTPiDdVGLTBWLRSP1gbbBlk1T/VblbGcsg9ne3e2H/9CF3BLvTl1rYmzuvHUpGZnhLmhwlgSblgpnxGHOo= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=DCuPeqOd; arc=none smtp.client-ip=209.85.128.46 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="DCuPeqOd" Received: by mail-wm1-f46.google.com with SMTP id 5b1f17b1804b1-490a767521dso6216315e9.1 for ; Tue, 09 Jun 2026 07:34:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1781015696; x=1781620496; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=zR5qTeZU+1AMo8bRv3wnu4lu6ZsL0raW9iT7/dFj7UM=; b=DCuPeqOdicg+vI5BvsSjmW5J8Z2qyh0QX73giFzzGaOBe9rI1j3zreuLaqC0RN7sGU 5+mzcK0wOcvgMav3pGl2pCTqE5ZC2l6u3qTdbMXw4eGlDud3NrEumos+h/D2f/e0e96j yMXjD4ajup10i00RJu1WgII13W6kDay6F3cYfEcJO5nUIzhJZtn2WJqZV4t5a/LwUD1Q uX9y4f2BthlprFaxfmPeQsTitASQXdUrdVQJeBdEpaBzIVRzu/AVQjb4KCnZrqwTTut6 y5vwidroMxCQ66y0gghDv97uYKCpPGJBNZE/Khl39NshpfczaxR6QnULs+PtrVw53dF5 AsdA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1781015696; x=1781620496; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=zR5qTeZU+1AMo8bRv3wnu4lu6ZsL0raW9iT7/dFj7UM=; b=h/xWNsevPZ4MwfEJvKleYTB7/C4wXZ4I+sPjjQugnwOn/YaV5Gwd8Jd6bJG8K/M0nl SIFl74HtglLwT72Jgwi2yr9kScsN4//fv4uX9gsL91ZZRNRuonq/PDIEG0lbqn5026Y4 zC2E3im3ItqijlZlmt0XMitw4fArK1brKiu65+ys8bBcvAMwbiI641GePPvFzDt6xp/l et/CXgPCl8dWv4l25PL4y8GY5rAt61zxTRnjo+ySyh+STz45KQlZ4qwFY2DEvXi/+8ID Ks6nLSy1Bygxbpx4XL9AUonj2y7bO4ht1Sn2GBreU8kOtlC6hteNP/v0up86CrN7em1c /ZxA== X-Forwarded-Encrypted: i=1; AFNElJ9QoCfjfL2LEIwEkRFK77yeGJHf2CvVMwM+Dsn++5L1tK3BiYKvWNbxAPOSK+2Rjzoqsp78Op3kwTxKzqc=@vger.kernel.org X-Gm-Message-State: AOJu0YxdtnJK5jfMJrtcdvnckDy7tXGmPi0k2AEdP5je2O/YRdT8eMDj pBOirGAeNqj+Q2t8iVgLqhG0dhSp1QvizIA1IdeyaKfVBTtmVZTITIPm X-Gm-Gg: Acq92OFcXhHUjzWpt0eOMELcbcgAW5tDIDv7Of01sDWEIcb1YzudmKtujGtDSCSoi94 dJNziGDgFbV0SBJNAFFnjE52QX6AUveJt0/5P0wbj0vWTFRNJ6qvIB7awggkhFpt6XiR7/rYL6V qmcxNg4aQk3LICwMdCrGy1fEDzLmBi76kgbA5JhdEuuY7ZhRiscXRHdBevzMI4ZWSi7kWkS9Km6 DGbM/bCjBdLCPlFBYvSIy2GIpfCTdR5a2nEuYypVw8A5QjW3nf5W0qaSIRLaHFgrS+6AWlD/v7s ll3ceHnxDCp1jZyzMPpWNPl9A7WV9+7zTyt+fPqWhg1jC31YDV81c4bbfcsvlsaGxDTeHSyOFax 1vmNTpstdFbdS8PA/SavyuQd8eVA022Kbh79C9NsvDf1yBZ+JEx+WdehoNartaT1SiPACt/jdDG mHl5f+uz7G8CXs4zRBahH5V+WCUt3X6ufuTJXtf2A0jba+kYGxt5ikRnE+yEy+nvAsyusuAQyDp NcXYYgz4TUV2Se31TJUL9mznZ0dn5rjHDZVbA== X-Received: by 2002:a05:600c:8b82:b0:490:abf1:2ddb with SMTP id 5b1f17b1804b1-490c2603825mr148448535e9.6.1781015696216; Tue, 09 Jun 2026 07:34:56 -0700 (PDT) Received: from doehyun-dev.pradel.rg.cispa.de (x06.xlate.fw.cispa.de. [195.37.157.6]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-4601f2dcad5sm68670615f8f.5.2026.06.09.07.34.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jun 2026 07:34:55 -0700 (PDT) From: Doehyun Baek To: Dongliang Mu Cc: Jonathan Corbet , Shuah Khan , SeongJae Park , Alex Shi , Yanteng Si , Hu Haowen <2023002089@link.tyut.edu.cn>, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, damon@lists.linux.dev, Doehyun Baek Subject: [PATCH v4 1/2] docs/mm/damon: fix DAMON documentation details Date: Tue, 9 Jun 2026 14:34:25 +0000 Message-ID: <2ef77f90822cdd3231b6d4b0acd5f4b458f9b1bc.1781015560.git.doehyunbaek@gmail.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Fix minor DAMON documentation issues. Correct the sysfs scheme file name apply_interval_us, the scheme directory count, the DAMON_STAT module count, a malformed reference, a misplaced label indentation, and a few typos. Signed-off-by: Doehyun Baek --- Documentation/admin-guide/mm/damon/usage.rst | 12 ++++++------ Documentation/mm/damon/design.rst | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 534e1199cf09..e6ad1b4106ef 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -232,7 +232,7 @@ writing to and reading from the files. Under ``nr_regions`` directory, two files for the lower-bound and upper-bound of DAMON's monitoring regions (``min`` and ``max``, respectively), which controls the monitoring overhead, exist. You can set and get the values by -writing to and rading from the files. +writing to and reading from the files. For more details about the intervals and monitoring regions range, please refer to the Design document (:doc:`/mm/damon/design`). @@ -250,7 +250,7 @@ Please refer to the :ref:`design document of the feature ` for the internal of the tuning mechanism. Reading and writing the four files under ``intervals_goal`` directory shows and updates the tuning parameters that described in the -:ref:design doc ` with the same +:ref:`design doc ` with the same names. The tuning starts with the user-set ``sample_us`` and ``aggr_us``. The tuning-applied current values of the two intervals can be read from the ``sample_us`` and ``aggr_us`` files after writing ``update_tuned_intervals`` to @@ -337,10 +337,10 @@ to ``N-1``. Each directory represents each DAMON-based operation scheme. schemes// ------------ -In each scheme directory, eight directories (``access_pattern``, ``quotas``, +In each scheme directory, nine directories (``access_pattern``, ``quotas``, ``watermarks``, ``core_filters``, ``ops_filters``, ``filters``, ``dests``, ``stats``, and ``tried_regions``) and three files (``action``, ``target_nid`` -and ``apply_interval``) exist. +and ``apply_interval_us``) exist. The ``action`` file is for setting and getting the scheme's :ref:`action `. The keywords that can be written to and read @@ -677,7 +677,7 @@ show results using tracepoint supporting tools like ``perf``. For example:: Each line of the perf script output represents each monitoring region. The first five fields are as usual other tracepoint outputs. The sixth field -(``target_id=X``) shows the ide of the monitoring target of the region. The +(``target_id=X``) shows the id of the monitoring target of the region. The seventh field (``nr_regions=X``) shows the total number of monitoring regions for the target. The eighth field (``X-Y:``) shows the start (``X``) and end (``Y``) addresses of the region in bytes. The ninth field (``X``) shows the @@ -687,7 +687,7 @@ counter). Finally the tenth field (``X``) shows the ``age`` of the region (refer to :ref:`design ` for more details of the counter). -If the event was ``damon:damos_beofre_apply``, the ``perf script`` output would +If the event was ``damon:damos_before_apply``, the ``perf script`` output would be somewhat like below:: kdamond.0 47293 [000] 80801.060214: damon:damos_before_apply: ctx_idx=0 scheme_idx=0 target_idx=0 nr_regions=11 121932607488-135128711168: 0 136 diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index afc7d52bda2f..aff89f73ca56 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -79,7 +79,7 @@ To know how user-space can do the configuration via :ref:`DAMON sysfs interface documentation. - .. _damon_design_vaddr_target_regions_construction: +.. _damon_design_vaddr_target_regions_construction: VMA-based Target Address Range Construction ------------------------------------------- @@ -858,11 +858,11 @@ control parameters for the usage would also need to be optimized for the purpose. To support such cases, yet more DAMON API user kernel modules that provide more -simple and optimized user space interfaces are available. Currently, two -modules for proactive reclamation and LRU lists manipulation are provided. For -more detail, please read the usage documents for those -(:doc:`/admin-guide/mm/damon/stat`, :doc:`/admin-guide/mm/damon/reclaim` and -:doc:`/admin-guide/mm/damon/lru_sort`). +simple and optimized user space interfaces are available. Currently, three +modules for access monitoring statistics, proactive reclamation, and LRU lists +manipulation are provided. For more detail, please read the usage documents for +those (:doc:`/admin-guide/mm/damon/stat`, :doc:`/admin-guide/mm/damon/reclaim` +and :doc:`/admin-guide/mm/damon/lru_sort`). .. _damon_design_special_purpose_modules_exclusivity: -- 2.43.0