linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Yanteng Si <siyanteng@loongson.cn>, alexs@kernel.org
Cc: chenhuacai@kernel.org, jiaxun.yang@flygoat.com,
	linux-doc@vger.kernel.org, realpuyuwang@gmail.com,
	bobwxc@email.cn, siyanteng01@gmail.com,
	huangjianghui@uniontech.com, Yanteng Si <siyanteng@loongson.cn>,
	Alex Shi <alexs@kernel.org>
Subject: Re: [PATCH v3] docs/zh_CN: add core-api workqueue.rst translation
Date: Thu, 13 May 2021 10:18:40 -0600	[thread overview]
Message-ID: <87o8de61zz.fsf@meer.lwn.net> (raw)
In-Reply-To: <87lf8i7jbj.fsf@meer.lwn.net>

Jonathan Corbet <corbet@lwn.net> writes:

> I've applied this, but...
>
> Yanteng Si <siyanteng@loongson.cn> writes:
>
>> v3:
>>
>> * Pick Alex'S review-by tag.
>>
>> v2:
>>
>> Some bad translations have been modified as suggested by Alex.Thank you for your review.
>> https://lore.kernel.org/linux-doc/CAEensMwq=i+nek6sNeqOJJMY648Q9ZF8cTKpXdJVuqdQQnMWUw@mail.gmail.com/T/#t
>>
>> v1:
>
> Text like the above belongs below the "---" line so I don't have to edit
> it out of the changelog by hand.
>
>> This patch translates Documentation/core-api/workqueue.rst into Chinese.
>>
>>
>> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
>> Reviewed-by: Alex Shi <alexs@kenrel.org>
>
> I fixed that typo too - it appears to originate from Alex...:)

Actually, I've dropped this back out; it creates vast numbers of
warnings:

> Documentation/core-api/workqueue:398: ./include/linux/workqueue.h:3: WARNING: Duplicate C declaration, also
> defined at translations/zh_CN/core-api/workqueue:3.

This will be the result of the ".. kernel-doc::" directives at the end,
which create new definitions (within sphinx) for all the symbols pulled
in.

In the long term, we may want to try to find some sort of fix for this.
But we're really just recreating a bunch of (English-language)
documentation that's already rendered once; I'm not sure it makes any
real sense to do that.  So I would suggest that, for now, when you are
translating documents with kernel-doc directives, you should leave those
directives out.  Stick in a note directing readers to the original if
they want to see that material...

Make sense?

Thanks,

jon


  reply	other threads:[~2021-05-13 16:18 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-12  8:33 [PATCH v3] docs/zh_CN: add core-api workqueue.rst translation Yanteng Si
2021-05-13 15:19 ` Jonathan Corbet
2021-05-13 16:18   ` Jonathan Corbet [this message]
2021-05-14  4:53     ` Alex Shi
2021-05-14  9:09       ` yanteng si
2021-05-14  9:30         ` Alex Shi
2021-05-14  9:47           ` yanteng si
2021-05-14 10:40             ` Alex Shi
2021-05-14 14:48               ` yanteng si

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=87o8de61zz.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=alexs@kernel.org \
    --cc=bobwxc@email.cn \
    --cc=chenhuacai@kernel.org \
    --cc=huangjianghui@uniontech.com \
    --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).