linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Mike Rapoport <rppt@kernel.org>
To: lsf-pc@lists.linux-foundation.org
Cc: linux-mm@kvack.org
Subject: [LSF/MM TOPIC] mm documentation
Date: Thu, 20 May 2021 11:56:09 +0300	[thread overview]
Message-ID: <YKYkKTZsWZg88tWd@kernel.org> (raw)

Hi,

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 prorams 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.


             reply	other threads:[~2021-05-20  8:56 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-20  8:56 Mike Rapoport [this message]
2021-05-20 14:19 ` [LSF/MM TOPIC] mm documentation Matthew Wilcox
2021-05-21  8:36   ` Mike Rapoport
2021-05-25  7:04     ` Souptick Joarder
  -- strict thread matches above, loose matches on Subject: below --
2019-01-28  7:04 [LSF/MM TOPIC]: " Mike Rapoport
2019-02-22 13:59 ` Jonathan Cameron
     [not found] <20180130105237.GB7201@rapoport-lnx>
2018-01-30 10:54 ` [LSF/MM TOPIC] " Mike Rapoport
2018-01-30 11:50   ` Michal Hocko
2018-01-30 12:54     ` Mike Rapoport
2018-01-30 13:41       ` Michal Hocko
2018-01-30 14:28         ` Mike Rapoport
2018-01-30 17:32           ` Randy Dunlap
2018-01-31 10:56             ` Mike Rapoport
2018-01-30 17:35           ` James Bottomley
2018-01-31  2:38           ` Matthew Wilcox
2018-01-31  9:00             ` Michal Hocko
2018-01-31 14:59               ` 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=YKYkKTZsWZg88tWd@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;
as well as URLs for NNTP newsgroup(s).