Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

mm: add orphaned kernel-doc to the rst files.

There are many files in mm/ that contain kernel-doc which is not
currently published on kernel.org. Some of it is easily categorisable,
but most of it is going into the miscellaneous documentation section to
be organised later.

Some files aren't ready to be included; they contain documentation with
build errors. Or they're nommu.c which duplicates documentation from
"real" MMU systems. Those files are noted with a # mark (although really
anything which isn't a recognised directive would do to prevent inclusion)

Link: https://lkml.kernel.org/r/20230818200630.2719595-5-willy@infradead.org
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Acked-by: Mike Rapoport (IBM) <rppt@kernel.org>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Matthew Wilcox (Oracle) and committed by
Andrew Morton
61ff748b 01a7eb3e

+31
+25
Documentation/core-api/mm-api.rst
··· 115 115 .. kernel-doc:: include/linux/mmzone.h 116 116 .. kernel-doc:: mm/util.c 117 117 :functions: folio_mapping 118 + 119 + .. kernel-doc:: mm/rmap.c 120 + .. kernel-doc:: mm/migrate.c 121 + .. kernel-doc:: mm/mmap.c 122 + .. kernel-doc:: mm/kmemleak.c 123 + .. #kernel-doc:: mm/hmm.c (build warnings) 124 + .. kernel-doc:: mm/memremap.c 125 + .. kernel-doc:: mm/hugetlb.c 126 + .. kernel-doc:: mm/swap.c 127 + .. kernel-doc:: mm/zpool.c 128 + .. kernel-doc:: mm/memcontrol.c 129 + .. #kernel-doc:: mm/memory-tiers.c (build warnings) 130 + .. kernel-doc:: mm/shmem.c 131 + .. kernel-doc:: mm/migrate_device.c 132 + .. #kernel-doc:: mm/nommu.c (duplicates kernel-doc from other files) 133 + .. kernel-doc:: mm/mapping_dirty_helpers.c 134 + .. #kernel-doc:: mm/memory-failure.c (build warnings) 135 + .. kernel-doc:: mm/percpu.c 136 + .. kernel-doc:: mm/maccess.c 137 + .. kernel-doc:: mm/vmscan.c 138 + .. kernel-doc:: mm/memory_hotplug.c 139 + .. kernel-doc:: mm/mmu_notifier.c 140 + .. kernel-doc:: mm/balloon_compaction.c 141 + .. kernel-doc:: mm/huge_memory.c 142 + .. kernel-doc:: mm/io-mapping.c
+1
Documentation/mm/highmem.rst
··· 206 206 ========= 207 207 208 208 .. kernel-doc:: include/linux/highmem.h 209 + .. kernel-doc:: mm/highmem.c 209 210 .. kernel-doc:: include/linux/highmem-internal.h
+5
Documentation/mm/zsmalloc.rst
··· 263 263 objects and release zspages. In these cases, it is recommended to decrease 264 264 the limit on the size of the zspage chains (as specified by the 265 265 CONFIG_ZSMALLOC_CHAIN_SIZE option). 266 + 267 + Functions 268 + ========= 269 + 270 + .. kernel-doc:: mm/zsmalloc.c