From: Wu XiangCheng <wu.xiangcheng@linux.dev>
To: Jonathan Corbet <corbet@lwn.net>, Alex Shi <alexs@kernel.org>,
Yanteng Si <siyanteng@loongson.cn>
Cc: Matthew Wilcox <willy@infradead.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-doc@vger.kernel.org
Subject: [PATCH] docs: kernel-doc.rst: move label "_kernel_doc" to top
Date: Sat, 13 Aug 2022 22:14:53 +0800 [thread overview]
Message-ID: <Yvex3fQSXFX3alIu@bobwxc.mipc> (raw)
From: Wu XiangCheng <bobwxc@email.cn>
"_kernel_doc" label which should refer to the entire document was in the
middle, move it to top. Also fix zh translation.
Fixes: 46347502b099 ("Restructure kernel-doc.rst")
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
---
Documentation/doc-guide/kernel-doc.rst | 3 ++-
Documentation/translations/zh_CN/doc-guide/kernel-doc.rst | 3 ++-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 9c779bd7a751..e494f907231e 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -1,5 +1,7 @@
.. title:: Kernel-doc comments
+.. _kernel_doc:
+
===========================
Writing kernel-doc comments
===========================
@@ -525,7 +527,6 @@ The kernel-doc extension is included in the kernel source tree, at
``scripts/kernel-doc`` script to extract the documentation comments from the
source.
-.. _kernel_doc:
How to use kernel-doc to generate man pages
-------------------------------------------
diff --git a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
index ccfb9b8329c2..48aad9868d4c 100644
--- a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
+++ b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
@@ -4,6 +4,8 @@
:译者: 吴想成 Wu XiangCheng <bobwxc@email.cn>
+.. _kernel_doc_zh:
+
编写kernel-doc注释
==================
@@ -475,7 +477,6 @@ doc: *title*
kernel-doc扩展包含在内核源代码树中，位于 ``Documentation/sphinx/kerneldoc.py`` 。
在内部，它使用 ``scripts/kernel-doc`` 脚本从源代码中提取文档注释。
-.. _kernel_doc_zh:
如何使用kernel-doc生成手册（man）页
-----------------------------------
--
2.30.2
next reply other threads:[~2022-08-13 14:15 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-13 14:14 Wu XiangCheng [this message]
2022-08-13 16:53 ` [PATCH] docs: kernel-doc.rst: move label "_kernel_doc" to top Jonathan Corbet
2022-08-14 0:12 ` Wu XiangCheng
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=Yvex3fQSXFX3alIu@bobwxc.mipc \
--to=wu.xiangcheng@linux.dev \
--cc=alexs@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=siyanteng@loongson.cn \
--cc=willy@infradead.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox