[PATCH] docs: kernel-doc.rst: move label "_kernel_doc" to top

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Wu XiangCheng <bobwxc@xxxxxxxx>

"_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@xxxxxxxx>
---
 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@xxxxxxxx>
 
+.. _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




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux