diff mbox series

[4/4] Docs/mm/index: move allocation profiling document to unsorted documents chapter

Message ID 20240701190512.49379-5-sj@kernel.org (mailing list archive)
State New
Headers show
Series Docs/mm: rename legacy docs to unsorted docs | expand

Commit Message

SeongJae Park July 1, 2024, 7:05 p.m. UTC
The memory allocation profiling document was added to the bottom of the
new outline.  Apparently it was not decided by well-defined guidelines
or a thorough discussions.  Rather than that, it was added there just
because there was no place for such unsorted documents.  Now there is
the chapter.  Move the document to the new place.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/mm/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jonathan Corbet July 3, 2024, 10:18 p.m. UTC | #1
SeongJae Park <sj@kernel.org> writes:

> The memory allocation profiling document was added to the bottom of the
> new outline.  Apparently it was not decided by well-defined guidelines
> or a thorough discussions.  Rather than that, it was added there just
> because there was no place for such unsorted documents.  Now there is
> the chapter.  Move the document to the new place.

I'll take this for now, but it's truly sad to see new documentation
being added to the slushpile at the end.  It seems better to create a
"development tools" section in the new outline and put the allocation
profiling document there?

Thanks,

jon
SeongJae Park July 3, 2024, 11 p.m. UTC | #2
On Wed, 03 Jul 2024 16:18:42 -0600 Jonathan Corbet <corbet@lwn.net> wrote:

> SeongJae Park <sj@kernel.org> writes:
> 
> > The memory allocation profiling document was added to the bottom of the
> > new outline.  Apparently it was not decided by well-defined guidelines
> > or a thorough discussions.  Rather than that, it was added there just
> > because there was no place for such unsorted documents.  Now there is
> > the chapter.  Move the document to the new place.
> 
> I'll take this for now, but it's truly sad to see new documentation
> being added to the slushpile at the end.  It seems better to create a
> "development tools" section in the new outline and put the allocation
> profiling document there?

I have no strong opinions about that.  Cc-ing Suren and Kent, as they are the
author of the allocation profiling document and hence might have some opinion.


Thanks,
SJ

[...]
Randy Dunlap July 4, 2024, 2:18 a.m. UTC | #3
On 7/3/24 7:10 PM, Suren Baghdasaryan wrote:
> On Wed, Jul 3, 2024 at 4:00 PM SeongJae Park <sj@kernel.org> wrote:
>>
>> On Wed, 03 Jul 2024 16:18:42 -0600 Jonathan Corbet <corbet@lwn.net> wrote:
>>
>>> SeongJae Park <sj@kernel.org> writes:
>>>
>>>> The memory allocation profiling document was added to the bottom of the
>>>> new outline.  Apparently it was not decided by well-defined guidelines
>>>> or a thorough discussions.  Rather than that, it was added there just
>>>> because there was no place for such unsorted documents.  Now there is
>>>> the chapter.  Move the document to the new place.
>>>
>>> I'll take this for now, but it's truly sad to see new documentation
>>> being added to the slushpile at the end.  It seems better to create a
>>> "development tools" section in the new outline and put the allocation
>>> profiling document there?
>>
>> I have no strong opinions about that.  Cc-ing Suren and Kent, as they are the
>> author of the allocation profiling document and hence might have some opinion.
> 
> IMHO if this would be the only document belonging to "development
> tools" then keeping it under unsorted is fine.
> If more documents will fall into that category then Jonathan's
> suggestion makes sense to me. Looking at the current list, page_owner
> and maybe damon might be considered for this category as well.
> SeongJae, WDYT?
> Thanks,
> Suren.
> 

Documentation/dev-tools/ already contains 20 files.
Unless you want to keep it under Documentation/mm/, that is.
Suren Baghdasaryan July 4, 2024, 2:36 a.m. UTC | #4
On Wed, Jul 3, 2024 at 7:18 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
>
>
> On 7/3/24 7:10 PM, Suren Baghdasaryan wrote:
> > On Wed, Jul 3, 2024 at 4:00 PM SeongJae Park <sj@kernel.org> wrote:
> >>
> >> On Wed, 03 Jul 2024 16:18:42 -0600 Jonathan Corbet <corbet@lwn.net> wrote:
> >>
> >>> SeongJae Park <sj@kernel.org> writes:
> >>>
> >>>> The memory allocation profiling document was added to the bottom of the
> >>>> new outline.  Apparently it was not decided by well-defined guidelines
> >>>> or a thorough discussions.  Rather than that, it was added there just
> >>>> because there was no place for such unsorted documents.  Now there is
> >>>> the chapter.  Move the document to the new place.
> >>>
> >>> I'll take this for now, but it's truly sad to see new documentation
> >>> being added to the slushpile at the end.  It seems better to create a
> >>> "development tools" section in the new outline and put the allocation
> >>> profiling document there?
> >>
> >> I have no strong opinions about that.  Cc-ing Suren and Kent, as they are the
> >> author of the allocation profiling document and hence might have some opinion.
> >
> > IMHO if this would be the only document belonging to "development
> > tools" then keeping it under unsorted is fine.
> > If more documents will fall into that category then Jonathan's
> > suggestion makes sense to me. Looking at the current list, page_owner
> > and maybe damon might be considered for this category as well.
> > SeongJae, WDYT?
> > Thanks,
> > Suren.
> >
>
> Documentation/dev-tools/ already contains 20 files.
> Unless you want to keep it under Documentation/mm/, that is.

I think it belongs more to mm than dev-tools TBH.

>
> --
> ~Randy
diff mbox series

Patch

diff --git a/Documentation/mm/index.rst b/Documentation/mm/index.rst
index 15614df2b989..0be1c7503a01 100644
--- a/Documentation/mm/index.rst
+++ b/Documentation/mm/index.rst
@@ -23,7 +23,6 @@  see the :doc:`admin guide <../admin-guide/mm/index>`.
    page_cache
    shmfs
    oom
-   allocation-profiling
 
 Unsorted Documentation
 ======================
@@ -38,6 +37,7 @@  documentation, or deleted if it has served its purpose.
    :maxdepth: 1
 
    active_mm
+   allocation-profiling
    arch_pgtable_helpers
    balance
    damon/index