mbox series

[0/4] Improve mm documentation

Message ID 20230818200630.2719595-1-willy@infradead.org (mailing list archive)
Headers show
Series Improve mm documentation | expand

Message

Matthew Wilcox Aug. 18, 2023, 8:06 p.m. UTC
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(-)