Skip to content

Commit 61ff748

Browse files
Matthew Wilcox (Oracle)akpm00
authored andcommitted
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>
1 parent 01a7eb3 commit 61ff748

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

Documentation/core-api/mm-api.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,28 @@ More Memory Management Functions
115115
.. kernel-doc:: include/linux/mmzone.h
116116
.. kernel-doc:: mm/util.c
117117
: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

Documentation/mm/highmem.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,4 +206,5 @@ Functions
206206
=========
207207

208208
.. kernel-doc:: include/linux/highmem.h
209+
.. kernel-doc:: mm/highmem.c
209210
.. kernel-doc:: include/linux/highmem-internal.h

Documentation/mm/zsmalloc.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,3 +263,8 @@ is heavy internal fragmentation and zspool compaction is unable to relocate
263263
objects and release zspages. In these cases, it is recommended to decrease
264264
the limit on the size of the zspage chains (as specified by the
265265
CONFIG_ZSMALLOC_CHAIN_SIZE option).
266+
267+
Functions
268+
=========
269+
270+
.. kernel-doc:: mm/zsmalloc.c

0 commit comments

Comments
 (0)