mbox series

[v3,0/3] docs/mm: start filling out new structure

Message ID 20230112091616.824565-1-rppt@kernel.org (mailing list archive)
Headers show
Series docs/mm: start filling out new structure | expand

Message

Mike Rapoport Jan. 12, 2023, 9:16 a.m. UTC 
From: "Mike Rapoport (IBM)" <rppt@kernel.org>

Hi,

Last year at LSF/MM Matthew promptly created the new structure for MM
documentation, but there still was no patches with content.

I've started to work on it a while ago and I wanted to send it out in a
more complete form, but I've got distracted and didn't have time to work
on this.

With fast changes around struct page and the threat of Lorenzo's book,
I've decided to send out what I have till now with a hope that we can
really make this a collaborative effort with people filling paragraph
here and there.

If somebody does not feel like sending formal patches, just send me the
"raw" text my way and I'll deal with the rest.

The text is relatively heavily formatted because I believe the target
audience will prefer html version.

v3:
* rephrase ZONE_DMA(32) and ZONE_MOVABLE description (Michal)
* add cross-reference to DMA API

v2: https://lore.kernel.org/all/20230110152358.2641910-1-rppt@kernel.org
* rephrase the paragraph inroducing zones (Lorenzo)
* update formatting (Bagas)
* add section stubs (Bagas)
* small fixes here and there

v1: https://lore.kernel.org/all/20230101094523.1522109-1-rppt@kernel.org

Mike Rapoport (IBM) (3):
  docs/core-api: DMA API: add page label to allow external references
  docs/mm: Page Reclaim: add page label to allow external references
  docs/mm: Physical Memory: add structure, introduction and nodes
    description

 Documentation/core-api/dma-api.rst   |   2 +
 Documentation/mm/page_reclaim.rst    |   2 +
 Documentation/mm/physical_memory.rst | 346 +++++++++++++++++++++++++++
 3 files changed, 350 insertions(+)

Comments

Bagas Sanjaya Jan. 13, 2023, 8:38 a.m. UTC | #1 
On Thu, Jan 12, 2023 at 11:16:13AM +0200, Mike Rapoport wrote:
> Mike Rapoport (IBM) (3):
>   docs/core-api: DMA API: add page label to allow external references
>   docs/mm: Page Reclaim: add page label to allow external references
>   docs/mm: Physical Memory: add structure, introduction and nodes
>     description

I'd like to squash [1/3] and [2/3] to actual doc [3/3], for which the
latter contains cross-references to labels defined in the former.
Indeed, IMO, adding required reference labels in some other place when
writing the doc can be constituted as part of writing the doc itself.

Thanks.