From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) (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 4EA7129D281 for ; Wed, 10 Jun 2026 05:40:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.41 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1781070010; cv=none; b=Nfeq1DfZrKOMxHpv1l1VwQHcP1nikobAv04BZxp2DY+h62aK0SpjHjm85mAI2m4n7tG+Mp/R95aOb8paci2qZvsxF9X5sw/01nrtj3uJTRtjaVPQsSBCJLRh5o5WjplLBGAf706X94VVOrurxc1lx/y3Avd8Jq0f0/If12uqV2c= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1781070010; c=relaxed/simple; bh=Qux6qw0K8leQGi/4WMI+uwr8oZG72FXB/rZyakTsEdE=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=Ntk9AEaXhjiUh1XgIUzpas312kiJoZCl5LSF8etMD7HeXzBSS+OlnETP3zAJ5kn3nKk99ejrw2bkcv+CJ1grWYZ5m06FcJXimaNhpCgmsHg2VAYvwVPu72fvJW0m0HuVnSHhjtDaAvdurv07p2/cBuWoZeYONlJraQek09MHFM4= 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=N0exQaLS; arc=none smtp.client-ip=209.85.221.41 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="N0exQaLS" Received: by mail-wr1-f41.google.com with SMTP id ffacd0b85a97d-45ef37b56e6so396258f8f.1 for ; Tue, 09 Jun 2026 22:40:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1781070006; x=1781674806; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=ZXdRRa/zk7c1is5MErVAcERRsYOulHfSrsDOswfrhUg=; b=N0exQaLSEHfqDcVb1wZwXb66ZyKD0Sbkdn3DU425L6s1sv6Ps7b3xmH508NcF69GIW +Udy434mvylp9+Rh3dCpramWrh1w4vRp9UAfJK9UMQIFbPraA8n4HNgNBLqs79K7mYIY fijEe9KgIxUz0zkvjA7Jse6lF2ipfK7KG2RUX4i/W4QSPDggwia0eLRtqVUnZ5LA6uOL 4xJ5/cAmnJ10yzAgSWVvEVwMDCqJxNy8hyWneaMTtNyN4ykopL8pmACLslVP/66nxo5o T1UNCj0wzhv6D3HK+wynliQzTaRVmLzW3esKNQ3q2vgMKcnE6WfMZ14QnDDyFt832X/2 Ojag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1781070006; x=1781674806; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=ZXdRRa/zk7c1is5MErVAcERRsYOulHfSrsDOswfrhUg=; b=cuT/tUM39HLLnsI6xdTHMPv7YYswr5yDYPL4nH3kWahYDu2iVCR+X7lJAqXWPuONG5 OPSZ6GRjAFySirHsrjQfQSTiXZYV4wCiHfpgXVYUi7ZzBqdm3ho43qaliT8uzg7QnjMZ ybFCvVsXr7KCikjGrRARB7AqJ6H/hT0HRPC16podK5hwfu402s0oifdgEMNZH44+13BC 0+YHu+3y5kpMzW7mWyFLqwISNQZg5uQVwgOEwegpnA1iQsOKQK2yrvRsIxqh+jfNi5Bn 8lEkKNrMwdY4ChGlscou/aI/ElzHPvbG2VuTQ2TP0i79/WSUQJ3Nlm2iT/4PmgUQ606B FgyA== X-Forwarded-Encrypted: i=1; AFNElJ/9iWEISfWdJVLI/poxaM+CTBOeWquhzN4344njgoIStuBAI1WbeXdGY7M3BbFbT3MZh9D7Q62fvGB0NP8=@vger.kernel.org X-Gm-Message-State: AOJu0YxINl7+9Y9q4bdCf52ZtaBm5cHWTAupJypsfptcXGh7HITAEIye UQPr3oN2+QNbh8yrsb3JFxqWV6ZxF8m0wsX7yykoUveilAsOirt9gjes X-Gm-Gg: Acq92OHazNdQSd9uDt7r1LtbNqOvsyu1o+tvT60j+7vVWIzQ0ShQIR4kjB/RwHG8HeP ChaD9QhlKTMHZAqnhvub0cpU51eCXysoKSINtujBL6870aT6QqpYGSGG8HNFVeBN3eDOq3DTo+J hvOvK4b49KUZAFEGB6F66G0mhy6JOPmNY8CVmL6EpCPlPm3zBGsrNENlDfX6qbqHQ3Gr8GP+bLm lB73T541aYKlbRTiipf8/n1rwLt2tGbCrELNWZd0VGxFgRsr6qpRZ0CI2Tlh1Oihisuazl5Ew0o 0l/S/f5MkW42hJOkYI+67P0VgVLQ8e1Glk8/xWQBvT7C3werINjPI6LraX4ejlWAIEKditZgiVL L3ewAl4lzec8kxng8bcrpn//jkBoJMP+fV0I2Mx7NlKrBlhrUnWhpQ+CVs6DhumHldVMagMf1+Y td6nPAbOsGsaFFNlmuQOz5Yb5cBuZ7e0bye6SWh0wZSO5A/kin2iFMIxIkaDMC0lP14Qvnstajn rBgKRwV+HiSu/BQJ2n2Skc5ZfTPewCwBZSo/14uvrUdlUVa X-Received: by 2002:a05:6000:70f:b0:45e:8a08:93fa with SMTP id ffacd0b85a97d-460566c1c21mr3027030f8f.4.1781070005579; Tue, 09 Jun 2026 22:40:05 -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-4601f2f2710sm53831009f8f.14.2026.06.09.22.40.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jun 2026 22:40:05 -0700 (PDT) From: Doehyun Baek To: SeongJae Park , Andrew Morton Cc: Doehyun Baek , David Hildenbrand , Lorenzo Stoakes , "Liam R. Howlett" , Vlastimil Babka , Mike Rapoport , Suren Baghdasaryan , Michal Hocko , Jonathan Corbet , Shuah Khan , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5] Docs/{admin-guide,mm}/damon: fix DAMON documentation details Date: Wed, 10 Jun 2026 05:39:50 +0000 Message-ID: <20260610053951.553739-1-doehyunbaek@gmail.com> X-Mailer: git-send-email 2.43.0 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 DAMON_STAT module count, a malformed reference, a misplaced label indentation, and a few typos. Signed-off-by: Doehyun Baek --- Changes from v4: - Rebased on mm-new. - Sent the English documentation fixes as a standalone patch. - Dropped the Chinese translation patch from this submission. Documentation/admin-guide/mm/damon/usage.rst | 8 ++++---- Documentation/mm/damon/design.rst | 12 ++++++------ 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 011296f1e7c2..b2649ea011f9 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -246,7 +246,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`). @@ -264,7 +264,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 @@ -377,7 +377,7 @@ schemes// 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 @@ -743,7 +743,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 2da7ca0d3d17..c16a3bb288d0 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -86,7 +86,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 ------------------------------------------- @@ -930,11 +930,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: base-commit: ce70d5abbf4f9930a07eddb06f40a0ea3494e33a -- 2.43.0