From: "Wu X.C." <bobwxc@email.cn>
To: Yanteng Si <siyanteng@loongson.cn>
Cc: Yanteng Si <siyanteng@loongson.cn>,
corbet@lwn.net, alexs@kernel.org, chenhuacai@kernel.org,
jiaxun.yang@flygoat.com, linux-doc@vger.kernel.org,
realpuyuwang@gmail.com, siyanteng01@gmail.com
Subject: Re: [PATCH 1/3] docs/zh_CN: add core-api kernel-api.rst translation
Date: Mon, 19 Apr 2021 22:33:48 +0800 [thread overview]
Message-ID: <20210419143347.GA24340@bobwxc.top> (raw)
In-Reply-To: <20210419133526.GB2531743@casper.infradead.org>
On Mon, Apr 19, 2021 at 02:35:26PM +0100, Matthew Wilcox wrote:
> On Mon, Apr 19, 2021 at 09:10:55PM +0800, Yanteng Si wrote:
> > This patch translates Documentation/core-api/kernel-api.rst into Chinese.
>
> I don't speak one word of Chinese, but this can't be right?
>
> > +列表管理函数
> > +============
> > +
> > +Todolist:
> > +
> > + :internal:
>
> The corresponding section in English is:
>
> List Management Functions
> =========================
>
> .. kernel-doc:: include/linux/list.h
> :internal:
>
> and surely you need a '.. kernel-doc' to have the ':internal:' make sense?
Yes, Matthew is right.
You need to call kernel-doc to generate related docs.
>
> Then, I wonder how useful it is to bring kernel-doc written in English
> into a Chinese document? Wouldn't we be better off admitting that we
> don't provide Chinese documentation for kernel APIs and referring to
> the English documents?
>
> (I would love nothing more than to provide Chinese documentation for
> kernel APIs, but we don't have any kind of system for providing that
> today)
Emm, I think, for the completeness of translation, it is worth.
But I want to know if the extra call to kernel-doc will significant
increase docs build time? If yes, I support add links to En rather than
simply put ..kernel-doc.
Thanks,
Wu.
next prev parent reply other threads:[~2021-04-19 14:34 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-19 13:10 [PATCH 0/3] add three core api docs Yanteng Si
2021-04-19 13:10 ` [PATCH 1/3] docs/zh_CN: add core-api kernel-api.rst translation Yanteng Si
2021-04-19 13:35 ` Matthew Wilcox
2021-04-19 14:33 ` Wu X.C. [this message]
2021-04-30 11:06 ` Alex Shi
2021-04-30 12:34 ` Matthew Wilcox
2021-04-30 15:05 ` Alex Shi
2021-04-19 13:10 ` [PATCH 2/3] docs/zh_CN: add core-api printk-basics.rst translation Yanteng Si
2021-04-19 16:19 ` Wu X.C.
2021-04-19 13:10 ` [PATCH 3/3] docs/zh_CN: add core-api printk-formats.rst translation Yanteng Si
2021-04-20 5:28 ` Wu X.C.
2021-04-21 7:15 ` teng sterling
2021-04-21 8:11 ` Wu X.C.
2021-04-21 9:54 ` teng sterling
2021-04-23 15:22 ` teng sterling
2021-04-23 16:05 ` Wu X.C.
2021-04-20 22:03 ` [PATCH 0/3] add three core api docs Jonathan Corbet
2021-04-21 1:50 ` teng sterling
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=20210419143347.GA24340@bobwxc.top \
--to=bobwxc@email.cn \
--cc=alexs@kernel.org \
--cc=chenhuacai@kernel.org \
--cc=corbet@lwn.net \
--cc=jiaxun.yang@flygoat.com \
--cc=linux-doc@vger.kernel.org \
--cc=realpuyuwang@gmail.com \
--cc=siyanteng01@gmail.com \
--cc=siyanteng@loongson.cn \
/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;
as well as URLs for NNTP newsgroup(s).