linux/Documentation/mm
Liew Rui Yan 4bdbddb4e4 Docs/mm/damon: document exclusivity of special-purpose modules
Add a section in design.rst to explain that DAMON special-purpose kernel
modules (LRU_SORT, RECLAIM, STAT) run in an exclusive manner and return
-EBUSY if another is already running.

Update lru_sort.rst, reclaim.rst and stat.rst by adding cross-references
to this exclusivity rule at the end of their respective Example sections.

This change is motivated from another discussion [1].

Link: https://lkml.kernel.org/r/20260315162945.80994-1-sj@kernel.org
Link: https://lore.kernel.org/damon/20260314002119.79742-1-sj@kernel.org/T/#t [1]
Signed-off-by: Liew Rui Yan <aethernet65535@gmail.com>
Reviewed-by: SeongJae Park <sj@kernel.org>
Signed-off-by: SeongJae Park <sj@kernel.org>
Cc: David Hildenbrand <david@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Liam Howlett <liam.howlett@oracle.com>
Cc: Lorenzo Stoakes (Oracle) <ljs@kernel.org>
Cc: Michal Hocko <mhocko@suse.com>
Cc: Mike Rapoport <rppt@kernel.org>
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>
History 2026-04-05 13:53:30 -07:00
..
damon Docs/mm/damon: document exclusivity of special-purpose modules 2026-04-05 13:53:30 -07:00
active_mm.rst Documentation: treewide: Replace marc.info links with lore 2025-11-03 16:21:31 -07:00
allocation-profiling.rst Docs/mm/allocation-profiling: describe sysctrl limitations in debug mode 2026-01-20 09:34:26 -08:00
arch_pgtable_helpers.rst Documentation/mm: drop pxx_mkdevmap() descriptions from page table helpers 2025-10-03 16:42:44 -07:00
balance.rst Documentation/mm: fix spelling mistake 2025-03-16 22:06:23 -07:00
bootmem.rst docs: rename Documentation/vm to Documentation/mm 2022-06-27 12:52:53 -07:00
free_page_reporting.rst docs/mm: remove useless markup 2023-02-02 10:18:05 -07:00
highmem.rst Documentation work keeps chugging along; stuff for 6.6 includes: 2023-08-30 20:05:42 -07:00
hmm.rst mm/rmap: convert make_device_exclusive_range() to make_device_exclusive() 2025-03-16 22:05:57 -07:00
hugetlbfs_reserv.rst Documentation: fix a hugetlbfs reservation statement 2026-04-05 13:53:12 -07:00
hwpoison.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
index.rst docs: add documentation for memfd preservation via LUO 2025-11-27 14:24:41 -08:00
ksm.rst docs/mm: remove useless markup 2023-02-02 10:18:05 -07:00
memfd_preservation.rst kho: docs: combine concepts and FDT documentation 2026-01-26 19:07:11 -08:00
memory-model.rst arch, mm: consolidate initialization of SPARSE memory model 2026-01-26 20:02:18 -08:00
mmu_notifier.rst docs/mm: remove useless markup 2023-02-02 10:18:05 -07:00
multigen_lru.rst mm: multi-gen LRU: improve design doc 2023-03-28 16:20:07 -07:00
numa.rst docs/mm: remove useless markup 2023-02-02 10:18:05 -07:00
oom.rst docs: rename Documentation/vm to Documentation/mm 2022-06-27 12:52:53 -07:00
overcommit-accounting.rst docs: mm: fix vm overcommit documentation for OVERCOMMIT_GUESS 2023-10-10 13:35:55 -06:00
page_allocation.rst docs: rename Documentation/vm to Documentation/mm 2022-06-27 12:52:53 -07:00
page_cache.rst ubifs: Convert ubifs_vm_page_mkwrite() to use a folio 2024-02-25 21:08:00 +01:00
page_frags.rst net: remove gfp_mask from napi_alloc_skb() 2024-03-28 18:30:40 -07:00
page_migration.rst docs/mm: convert from "Non-LRU page migration" to "movable_ops page migration" 2025-07-13 16:38:32 -07:00
page_owner.rst mm/page_owner: update Documentation with 'show_handles' and 'show_stacks_handles' 2025-11-16 17:27:59 -08:00
page_reclaim.rst docs/mm: Physical Memory: remove useless markup 2023-02-02 10:18:04 -07:00
page_table_check.rst mm/page_table_check: support userfault wr-protect entries 2024-05-05 17:53:41 -07:00
page_tables.rst Docs/mm: fix typos and grammar in page_tables.rst 2026-02-14 10:12:14 -07:00
physical_memory.rst docs: update physical memory documentation by adding N_GENERIC_INITIATOR to enum node_states 2025-08-11 11:03:37 -06:00
process_addrs.rst compiler-context-analysis: Remove __cond_lock() function-like helper 2026-01-05 16:43:33 +01:00
remap_file_pages.rst docs/mm: remove useless markup 2023-02-02 10:18:05 -07:00
shmfs.rst docs: rename Documentation/vm to Documentation/mm 2022-06-27 12:52:53 -07:00
slab.rst doc: Add slab internal kernel-doc 2025-06-18 13:06:26 +02:00
split_page_table_lock.rst mm: pgtable: Fix grammar error 2025-02-04 09:40:14 -07:00
swap-table.rst docs/mm: add document for swap table 2025-09-21 14:22:22 -07:00
swap.rst docs: rename Documentation/vm to Documentation/mm 2022-06-27 12:52:53 -07:00
transhuge.rst mm: stop maintaining the per-page mapcount of large folios (CONFIG_NO_PAGE_MAPCOUNT) 2025-03-17 22:06:48 -07:00
unevictable-lru.rst mm: remove isolate_lru_page() 2024-09-09 16:38:59 -07:00
vmalloc.rst docs: rename Documentation/vm to Documentation/mm 2022-06-27 12:52:53 -07:00
vmalloced-kernel-stacks.rst docs:mm: fixed spelling and grammar mistakes on vmalloc kernel stack page 2024-09-10 15:31:45 -06:00
vmemmap_dedup.rst hugetlb: update vmemmap_dedup.rst 2026-04-05 13:53:10 -07:00
zsmalloc.rst mm: zsmalloc: remove object mapping APIs and per-CPU map areas 2025-03-17 00:05:41 -07:00