Linux Documentation
 help / color / mirror / Atom feed
From: Wu XiangCheng <wu.xiangcheng@linux.dev>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Alex Shi <alexs@kernel.org>, Yanteng Si <siyanteng@loongson.cn>,
	Matthew Wilcox <willy@infradead.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: kernel-doc.rst: move label "_kernel_doc" to top
Date: Sun, 14 Aug 2022 08:12:06 +0800	[thread overview]
Message-ID: <Yvg91r1izkJyY31M@bobwxc.mipc> (raw)
In-Reply-To: <87zgg8w0ee.fsf@meer.lwn.net>

话说 Jonathan Corbet 于 2022-08-13 (六) 10:53:13 -0600 曰过:
> Wu XiangCheng <wu.xiangcheng@linux.dev> writes:
> 
> > 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(-)
> 
> Rather than do this, is there any reason to not just delete the label
> entirely?  If anything references it, it can just name the file instead.
> But, as it happens, it's not even referenced anywhere...

Emmm, it's referenced. Remember to remove prefix '_' when grep.
Would you like to transfer all below references to path style?

$git grep -n "<kernel_doc>"
Documentation/process/submit-checklist.rst:64:11) Include :ref:`kernel-doc <kernel_doc>` to document global  kernel APIs.
Documentation/process/submit-checklist.rst:67:    :ref:`kernel-doc <kernel_doc>` and fix any issues.
Documentation/translations/it_IT/process/submit-checklist.rst:69:11) Includete commenti :ref:`kernel-doc <kernel_doc>` per documentare API
Documentation/translations/it_IT/process/submit-checklist.rst:71:    verificare i commenti :ref:`kernel-doc <kernel_doc>` ed eventualmente
Documentation/translations/zh_CN/process/submit-checklist.rst:59:11) 包括 :ref:`kernel-doc <kernel_doc>` 内核文档以记录全局内核API。(静态函数
Documentation/translations/zh_CN/process/submit-checklist.rst:61:    :ref:`kernel-doc <kernel_doc>` 并修复任何问题。
Documentation/translations/zh_TW/process/submit-checklist.rst:62:11) 包括 :ref:`kernel-doc <kernel_doc>` 內核文檔以記錄全局內核API。(靜態函數
Documentation/translations/zh_TW/process/submit-checklist.rst:64:    :ref:`kernel-doc <kernel_doc>` 並修復任何問題。

Thanks,

-- 
Wu XiangCheng	0x32684A40BCA7AEA7


      reply	other threads:[~2022-08-14  0:12 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-13 14:14 [PATCH] docs: kernel-doc.rst: move label "_kernel_doc" to top Wu XiangCheng
2022-08-13 16:53 ` Jonathan Corbet
2022-08-14  0:12   ` Wu XiangCheng [this message]

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=Yvg91r1izkJyY31M@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