| Message ID | 20240701190512.49379-1-sj@kernel.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | Docs/mm: rename legacy docs to unsorted docs | expand |
SeongJae Park <sj@kernel.org> writes: > 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. Series applied, thanks. jon
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