linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Wu XiangCheng <bobwxc@email.cn>, Alex Shi <alexs@kernel.org>
Cc: Alex Shi <seakeel@gmail.com>, YanTeng Si <sterlingteng@gmail.com>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH v5 2/7] docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst
Date: Tue, 13 Apr 2021 15:57:12 -0600	[thread overview]
Message-ID: <87lf9lrgp3.fsf@meer.lwn.net> (raw)
In-Reply-To: <783d134b1dd18f580f2c0511c2330382a86e79b5.1618295149.git.bobwxc@email.cn>

Wu XiangCheng <bobwxc@email.cn> writes:

> Add new translation
>   Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
>
> Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
> Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
> ---
>  .../zh_CN/doc-guide/kernel-doc.rst            | 500 ++++++++++++++++++
>  1 file changed, 500 insertions(+)
>  create mode 100644 Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
>
> diff --git a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
> new file mode 100644
> index 000000000000..b0427944f8f0
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
> @@ -0,0 +1,500 @@
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/doc-guide/kernel-doc.rst
> +
> +:译者: 吴想成 Wu XiangCheng <bobwxc@email.cn>
> +
> +编写kernel-doc注释
> +==================
> +
> +Linux内核源文件可以包含kernel-doc格式的结构化文档注释,用以描述代码的函数、
> +类型和设计。将文档嵌入源文件更容易保持文档最新。
> +
> +.. note:: 内核文档格式与javadoc、gtk-doc或Doxygen看似很相似,但由于历史原因,
> +          实际有着明显的不同。内核源包含成千上万个kernel-doc注释。请坚持遵循
> +          此处描述的风格。
> +
> +.. note:: kernel-doc无法包含Rust代码:请参考
> +          :ref:`Documentation/rust/docs.rst <rust_docs>`。

Note that this reference adds a warning to the docs-next build - this
translation is evidently against linux-next instead.  The warning will
eventually go away, but it would be better not to do this if possible.

Also, there is no need for a :ref: here; just say
"Documentation/rust/docs.rst" and the automarkup code will do the right
thing.  Yes, that should be changed in the original as well.

Thanks,

jon

  parent reply	other threads:[~2021-04-13 21:57 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-13  7:11 [PATCH v5 0/7] docs/zh_CN: Add translations in zh_CN/doc-guide/ Wu XiangCheng
2021-04-13  7:11 ` [PATCH v5 1/7] docs/zh_CN: Add translation zh_CN/doc-guide/sphinx.rst Wu XiangCheng
2021-04-13  8:48   ` Alex Shi
2021-04-13  7:12 ` [PATCH v5 2/7] docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst Wu XiangCheng
2021-04-13  8:48   ` Alex Shi
2021-04-13 21:57   ` Jonathan Corbet [this message]
2021-04-14  2:38     ` Wu X.C.
2021-04-14 16:41       ` Jonathan Corbet
2021-04-13  7:12 ` [PATCH v5 3/7] docs/zh_CN: Add translation zh_CN/doc-guide/parse-headers.rst Wu XiangCheng
2021-04-13  8:48   ` Alex Shi
2021-04-13  8:54   ` Alex Shi
2021-04-13  7:12 ` [PATCH v5 4/7] docs/zh_CN: Add translation zh_CN/doc-guide/contributing.rst Wu XiangCheng
2021-04-13  8:49   ` Alex Shi
2021-04-13  7:13 ` [PATCH v5 5/7] docs/zh_CN: Add translation zh_CN/doc-guide/maintainer-profile.rst Wu XiangCheng
2021-04-13  8:49   ` Alex Shi
2021-04-13  7:13 ` [PATCH v5 6/7] docs/zh_CN: Add translation zh_CN/doc-guide/index.rst Wu XiangCheng
2021-04-13  8:49   ` Alex Shi
2021-04-13  7:13 ` [PATCH v5 7/7] docs/zh_CN: Link zh_CN/doc-guide to zh_CN/index.rst Wu XiangCheng
2021-04-13  8:49   ` Alex Shi
2021-04-13 21:06 ` [PATCH v5 0/7] docs/zh_CN: Add translations in zh_CN/doc-guide/ Jonathan Corbet

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=87lf9lrgp3.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=alexs@kernel.org \
    --cc=bobwxc@email.cn \
    --cc=linux-doc@vger.kernel.org \
    --cc=seakeel@gmail.com \
    --cc=sterlingteng@gmail.com \
    --subject='Re: [PATCH v5 2/7] docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).