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

Commit Message

Matthew Wilcox June 17, 2021, 8:43 p.m. UTC

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) <[e-mail]>
---
 Documentation/vm/z3fold.rst   | 5 +++++
 Documentation/vm/zsmalloc.rst | 7 +++++++
 2 files changed, 12 insertions(+)

Patch

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