linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: SeongJae Park <sj@kernel.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: SeongJae Park <sj@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	Kent Overstreet <kent.overstreet@linux.dev>,
	Suren Baghdasaryan <surenb@google.com>,
	linux-mm@kvack.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH 0/4] Docs/mm: rename legacy docs to unsorted docs
Date: Mon,  1 Jul 2024 12:05:08 -0700	[thread overview]
Message-ID: <20240701190512.49379-1-sj@kernel.org> (raw)

The work for changing the memory mangement documentation outline has
started from 2022.  For that, old documents have placed under new
chapter, "Legacy Documentations".  The plan is to eventually move all
old documentations into new outline, while asking new documents to be
added on the new outline from the beginning.

However, it is unclear where on the new outline each document should be
placed for some cases.  Meanwhile, the name ("legacy") makes readers
feel the documents under the chapter might be outdated or not actively
maintained.  The absence of clear criteria for new outline also makes
new documents difficult to find where those should be placed.  A new
document was put on the bottom of the new outline recently, apparently
not based on a clear guideline but just because it is the bottom of the
list.

Rename the "Legagy Documentation" chapter to "Unsorted Documentations"
with minor fixups.

SeongJae Park (4):
  Docs/mm/allocation-profiling: mark 'Theory of operation' as chapter
  Docs/mm/index: Remove 'Memory Management Guide' chapter marker
  Docs/mm/index: rename 'Legacy Documentation' to 'Unsorted
    Documentation'
  Docs/mm/index: move allocation profiling document to unsorted
    documents chapter

 Documentation/mm/allocation-profiling.rst |  1 -
 Documentation/mm/index.rst                | 19 ++++++++-----------
 2 files changed, 8 insertions(+), 12 deletions(-)


base-commit: 5dc709e59ba6486e519b22f86278c978b422a025
-- 
2.39.2



             reply	other threads:[~2024-07-01 19:05 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-01 19:05 SeongJae Park [this message]
2024-07-01 19:05 ` [PATCH 1/4] Docs/mm/allocation-profiling: mark 'Theory of operation' as chapter SeongJae Park
2024-07-01 21:29   ` Suren Baghdasaryan
2024-07-01 19:05 ` [PATCH 2/4] Docs/mm/index: Remove 'Memory Management Guide' chapter marker SeongJae Park
2024-07-01 19:05 ` [PATCH 3/4] Docs/mm/index: rename 'Legacy Documentation' to 'Unsorted Documentation' SeongJae Park
2024-07-01 19:05 ` [PATCH 4/4] Docs/mm/index: move allocation profiling document to unsorted documents chapter SeongJae Park
2024-07-03 22:18   ` Jonathan Corbet
2024-07-03 23:00     ` SeongJae Park
     [not found]       ` <CAJuCfpFO_C_LgxrRWrxG9o==RRtYAbkbP3ZJULwdmTjDcAJNrg@mail.gmail.com>
2024-07-04  2:18         ` Randy Dunlap
2024-07-04  2:36           ` Suren Baghdasaryan
2024-07-04  3:33         ` SeongJae Park
2024-07-03 22:20 ` [PATCH 0/4] Docs/mm: rename legacy docs to unsorted docs Jonathan Corbet

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=20240701190512.49379-1-sj@kernel.org \
    --to=sj@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=kent.overstreet@linux.dev \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=surenb@google.com \
    /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).