From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>,
linux-mm@kvack.org, Mike Rapoport <rppt@kernel.org>,
linux-doc@vger.kernel.org, cgroups@vger.kernel.org
Subject: [PATCH 0/4] Improve mm documentation
Date: Fri, 18 Aug 2023 21:06:26 +0100 [thread overview]
Message-ID: <20230818200630.2719595-1-willy@infradead.org> (raw)
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
next reply other threads:[~2023-08-18 20:06 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-18 20:06 Matthew Wilcox (Oracle) [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230818200630.2719595-1-willy@infradead.org \
--to=willy@infradead.org \
--cc=akpm@linux-foundation.org \
--cc=cgroups@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=rppt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox