Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

Docs/mm/index: rename 'Legacy Documentation' to 'Unsorted Documentation'

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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240701190512.49379-4-sj@kernel.org

authored by

SeongJae Park and committed by
Jonathan Corbet
9472274c 8c678c9c

+7 -7
+7 -7
Documentation/mm/index.rst
··· 25 25 oom 26 26 allocation-profiling 27 27 28 - Legacy Documentation 29 - ==================== 28 + Unsorted Documentation 29 + ====================== 30 30 31 - This is a collection of older documents about the Linux memory management 32 - (MM) subsystem internals with different level of details ranging from 33 - notes and mailing list responses for elaborating descriptions of data 34 - structures and algorithms. It should all be integrated nicely into the 35 - above structured documentation, or deleted if it has served its purpose. 31 + This is a collection of unsorted documents about the Linux memory management 32 + (MM) subsystem internals with different level of details ranging from notes and 33 + mailing list responses for elaborating descriptions of data structures and 34 + algorithms. It should all be integrated nicely into the above structured 35 + documentation, or deleted if it has served its purpose. 36 36 37 37 .. toctree:: 38 38 :maxdepth: 1