From: SeongJae Park <sj@kernel.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: SeongJae Park <sj@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
linux-mm@kvack.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 3/4] Docs/mm/index: rename 'Legacy Documentation' to 'Unsorted Documentation'
Date: Mon, 1 Jul 2024 12:05:11 -0700 [thread overview]
Message-ID: <20240701190512.49379-4-sj@kernel.org> (raw)
In-Reply-To: <20240701190512.49379-1-sj@kernel.org>
The intention of 'Legacy Documentation' chapter is to keep the old
documents that not yet sorted into the new outline, and encourage new
documents to be integrated in the new outline from the beginning.
However, the new outline will take some more time to be completed. It
has started about two years ago, and still many parts are not yet
written. Also, there is no clear guidline for placing each document for
all cases, for not only the 'legacy' documents, but also for new
documents. For example, memory allocation profiling document has been
added to the bottom of the new outline. Apparently it was not following
some well-defined guideliens or a result of a discussion.
Furthermore, the title ("legacy") makes people feel the documents on the
chapter might be outdated or not actively maintained.
Rename 'Legacy Documentation' to 'Unsorted Documentation' and remove the
description saying it is for 'older' documents. After this change, new
documents that not clear enough where it should be placed on the new
outline can be added on the chapter while well-defined guidelines or
discussion for the new outline is made.
Signed-off-by: SeongJae Park <sj@kernel.org>
---
Documentation/mm/index.rst | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/mm/index.rst b/Documentation/mm/index.rst
index 5007815405f1..15614df2b989 100644
--- a/Documentation/mm/index.rst
+++ b/Documentation/mm/index.rst
@@ -25,14 +25,14 @@ see the :doc:`admin guide <../admin-guide/mm/index>`.
oom
allocation-profiling
-Legacy Documentation
-====================
+Unsorted Documentation
+======================
-This is a collection of older documents about the Linux memory management
-(MM) subsystem internals with different level of details ranging from
-notes and mailing list responses for elaborating descriptions of data
-structures and algorithms. It should all be integrated nicely into the
-above structured documentation, or deleted if it has served its purpose.
+This is a collection of unsorted documents about the Linux memory management
+(MM) subsystem internals with different level of details ranging from notes and
+mailing list responses for elaborating descriptions of data structures and
+algorithms. It should all be integrated nicely into the above structured
+documentation, or deleted if it has served its purpose.
.. toctree::
:maxdepth: 1
--
2.39.2
next prev parent 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 [PATCH 0/4] Docs/mm: rename legacy docs to unsorted docs SeongJae Park
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 ` SeongJae Park [this message]
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-4-sj@kernel.org \
--to=sj@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.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).