All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
To: linux-mm@kvack.org, linux-doc@vger.kernel.org
Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>
Subject: [PATCH 1/3] mm/doc: Include compressed memory kernel-doc
Date: Thu, 17 Jun 2021 21:43:23 +0100	[thread overview]
Message-ID: <20210617204325.2278730-1-willy@infradead.org> (raw)

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


             reply	other threads:[~2021-06-17 20:44 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-17 20:43 Matthew Wilcox (Oracle) [this message]
2021-06-17 20:43 ` [PATCH 2/3] mm/doc: Add some more missing kernel-doc Matthew Wilcox (Oracle)
2021-06-17 20:43 ` [PATCH 3/3] mm/doc: Include percpu documentation in html docs Matthew Wilcox (Oracle)
2021-06-17 21:54   ` Dennis Zhou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210617204325.2278730-1-willy@infradead.org \
    --to=willy@infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.