[PATCH 1/3] mm/doc: Include compressed memory kernel-doc

[PATCH 1/3] mm/doc: Include compressed memory kernel-doc

[Matthew Wilcox (Oracle)]

People have gone to a lot of trouble to write all this documentation;
include it as part of the htmldocs.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
 Documentation/vm/z3fold.rst   | 5 +++++
 Documentation/vm/zsmalloc.rst | 7 +++++++
 2 files changed, 12 insertions(+)

diff --git a/Documentation/vm/z3fold.rst b/Documentation/vm/z3fold.rst
index 224e3c61d686..1e1fd3c46290 100644
--- a/Documentation/vm/z3fold.rst
+++ b/Documentation/vm/z3fold.rst
@@ -28,3 +28,8 @@ handle which encodes actual location of the allocated object.
 Keeping effective compression ratio close to zsmalloc's, z3fold doesn't
 depend on MMU enabled and provides more predictable reclaim behavior
 which makes it a better fit for small and response-critical systems.
+
+Functions and structures
+========================
+
+.. kernel-doc:: mm/z3fold.c
diff --git a/Documentation/vm/zsmalloc.rst b/Documentation/vm/zsmalloc.rst
index 6e79893d6132..32bda5f31e6b 100644
--- a/Documentation/vm/zsmalloc.rst
+++ b/Documentation/vm/zsmalloc.rst
@@ -80,3 +80,10 @@ Similarly, we assign zspage to:
 * ZS_ALMOST_FULL  when n > N / f
 * ZS_EMPTY        when n == 0
 * ZS_FULL         when n == N
+
+Functions and structures
+========================
+
+.. kernel-doc:: mm/zsmalloc.c
+.. kernel-doc:: mm/zbud.c
+.. kernel-doc:: mm/zpool.c
-- 
2.30.2

[PATCH 2/3] mm/doc: Add some more missing kernel-doc

[Matthew Wilcox (Oracle)]

All these functions have kernel-doc that's not being included.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
 Documentation/core-api/mm-api.rst | 4 ++++
 Documentation/vm/transhuge.rst    | 6 ++++++
 2 files changed, 10 insertions(+)

diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
index a42f9baddfbf..e46f01c4b200 100644
--- a/Documentation/core-api/mm-api.rst
+++ b/Documentation/core-api/mm-api.rst
@@ -66,6 +66,8 @@ File Mapping and Page Cache
 
 .. kernel-doc:: mm/page-writeback.c
    :export:
+.. kernel-doc:: mm/backing-dev.c
+   :export:
 
 .. kernel-doc:: mm/truncate.c
    :export:
@@ -93,6 +95,8 @@ More Memory Management Functions
 
 .. kernel-doc:: mm/page_alloc.c
 .. kernel-doc:: mm/mempolicy.c
+.. kernel-doc:: mm/vmscan.c
+   :export:
 .. kernel-doc:: include/linux/mm_types.h
    :internal:
 .. kernel-doc:: include/linux/mm.h
diff --git a/Documentation/vm/transhuge.rst b/Documentation/vm/transhuge.rst
index 216db1d67d04..550dea445528 100644
--- a/Documentation/vm/transhuge.rst
+++ b/Documentation/vm/transhuge.rst
@@ -185,3 +185,9 @@ a THP crosses a VMA boundary.
 The function deferred_split_huge_page() is used to queue a page for splitting.
 The splitting itself will happen when we get memory pressure via shrinker
 interface.
+
+Functions and structures
+========================
+
+.. kernel-doc:: mm/huge_memory.c
+.. kernel-doc:: mm/khugepaged.c
-- 
2.30.2

[PATCH 3/3] mm/doc: Include percpu documentation in html docs

[Matthew Wilcox (Oracle)]

The kernel-doc was written, but not included in the html documentation.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
 Documentation/core-api/mm-api.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
index e46f01c4b200..89a53ac00249 100644
--- a/Documentation/core-api/mm-api.rst
+++ b/Documentation/core-api/mm-api.rst
@@ -87,6 +87,12 @@ DMA pools
 .. kernel-doc:: mm/dmapool.c
    :export:
 
+Per-CPU memory allocation
+=========================
+
+.. kernel-doc:: mm/percpu.c
+   :export:
+
 More Memory Management Functions
 ================================
 
-- 
2.30.2

Re: [PATCH 3/3] mm/doc: Include percpu documentation in html docs

[Dennis Zhou]

Hello,

On Thu, Jun 17, 2021 at 09:43:25PM +0100, Matthew Wilcox (Oracle) wrote:
> The kernel-doc was written, but not included in the html documentation.
> 
> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
> ---
>  Documentation/core-api/mm-api.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
> index e46f01c4b200..89a53ac00249 100644
> --- a/Documentation/core-api/mm-api.rst
> +++ b/Documentation/core-api/mm-api.rst
> @@ -87,6 +87,12 @@ DMA pools
>  .. kernel-doc:: mm/dmapool.c
>     :export:
>  
> +Per-CPU memory allocation
> +=========================
> +
> +.. kernel-doc:: mm/percpu.c
> +   :export:
> +
>  More Memory Management Functions
>  ================================
>  
> -- 
> 2.30.2
> 
> 

Acked-by: Dennis Zhou <dennis@kernel.org>

Thanks,
Dennis