From: Mike Rapoport <rppt@kernel.org>
To: lsf-pc@lists.linux-foundation.org, linux-mm@kvack.org
Subject: [LSF/MM/BPF TOPIC] mm documentation
Date: Tue, 1 Feb 2022 21:03:16 +0200 [thread overview]
Message-ID: <YfmD9Pa92xousy5b@kernel.org> (raw)
Hi all,
I'm suggesting this topic for a while now, maybe if we finally get to talk
about it in person something will improve :)
The mm documentation is, well, not entirely up to date. We can opt for
dropping the outdated parts, which would generate a nice negative
diffstat, but identifying the outdated documentation requires nearly
as much effort as updating it, so I think that making and keeping
the docs up to date would be a better option.
I'd like to discuss what can be done process-wise to improve the
situation.
Some points I had in mind:
* Pay more attention to docs during review
* Set an expectation level for docs accompanying a changeset
* Spend some cycles to review and update the existing docs
* Spend some more cycles to add new documentation
* Participate in programs like Google Season of Docs
I'd appreciate a discussion about how we can improve the existing memory
management documentation so that a reader can get a coherent view of it,
what are the gaps (although they are too many), and what would be the best
way to close these gaps.
--
Sincerely yours,
Mike.
next reply other threads:[~2022-02-01 19:03 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-01 19:03 Mike Rapoport [this message]
2023-05-12 1:39 ` Lorenzo Stoakes
2023-05-12 17:37 ` Mike Rapoport
2023-05-13 11:21 ` Lorenzo Stoakes
2023-05-15 6:07 ` Mike Rapoport
2023-05-16 15:10 ` Jonathan Corbet
2023-05-21 23:50 ` David Rientjes
2023-05-22 7:47 ` Lorenzo Stoakes
2023-05-23 8:50 ` Mike Rapoport
-- strict thread matches above, loose matches on Subject: below --
2020-02-06 16:53 [LSF/MM/BPF TOPIC]: MM documentation Mike Rapoport
2020-02-17 1:10 ` Ira Weiny
2020-02-22 2:15 ` John Hubbard
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=YfmD9Pa92xousy5b@kernel.org \
--to=rppt@kernel.org \
--cc=linux-mm@kvack.org \
--cc=lsf-pc@lists.linux-foundation.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