linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/4] Improve mm documentation
@ 2023-08-18 20:06 Matthew Wilcox (Oracle)
  2023-08-18 20:06 ` [PATCH 1/4] mm: Fix kernel-doc warning from tlb_flush_rmaps() Matthew Wilcox (Oracle)
                   ` (3 more replies)
  0 siblings, 4 replies; 12+ messages in thread
From: Matthew Wilcox (Oracle) @ 2023-08-18 20:06 UTC (permalink / raw)
  To: Andrew Morton
  Cc: Matthew Wilcox (Oracle), linux-mm, Mike Rapoport, linux-doc, cgroups

If you build with W=1, kernel-doc complains about tlb_flush_rmaps().
Then I ran scripts/find-unused-docs.sh against mm/ and found a large
number of files which weren't included in the ReST documentation.
I fixed up a couple of them, and added all those without erros to the
rst files.  There's a lot more work to do to organise all of this, but
at least now if we have documentation that refers to these functions,
we'll get a nice link to them.

Matthew Wilcox (Oracle) (4):
  mm: Fix kernel-doc warning from tlb_flush_rmaps()
  mm: Fix get_mctgt_type() kernel-doc
  mm: Fix clean_record_shared_mapping_range kernel-doc
  mm: Add orphaned kernel-doc to the rst files.

 Documentation/core-api/mm-api.rst | 25 +++++++++++++++++++++++++
 Documentation/mm/highmem.rst      |  1 +
 Documentation/mm/zsmalloc.rst     |  5 +++++
 mm/mapping_dirty_helpers.c        | 11 ++++++-----
 mm/memcontrol.c                   | 31 +++++++++++++------------------
 mm/mmu_gather.c                   |  1 +
 6 files changed, 51 insertions(+), 23 deletions(-)

-- 
2.40.1



^ permalink raw reply	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2023-08-21 14:56 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-08-18 20:06 [PATCH 0/4] Improve mm documentation Matthew Wilcox (Oracle)
2023-08-18 20:06 ` [PATCH 1/4] mm: Fix kernel-doc warning from tlb_flush_rmaps() Matthew Wilcox (Oracle)
2023-08-20  0:51   ` Randy Dunlap
2023-08-21 14:51   ` Mike Rapoport
2023-08-18 20:06 ` [PATCH 2/4] mm: Fix get_mctgt_type() kernel-doc Matthew Wilcox (Oracle)
2023-08-20  0:52   ` Randy Dunlap
2023-08-21 14:53   ` Mike Rapoport
2023-08-18 20:06 ` [PATCH 3/4] mm: Fix clean_record_shared_mapping_range kernel-doc Matthew Wilcox (Oracle)
2023-08-20  0:51   ` Randy Dunlap
2023-08-21 14:54   ` Mike Rapoport
2023-08-18 20:06 ` [PATCH 4/4] mm: Add orphaned kernel-doc to the rst files Matthew Wilcox (Oracle)
2023-08-21 14:55   ` Mike Rapoport

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox