Re: [PATCH v2 17/19] docs: replace transation references for reporting-bugs.rst

Federico Vaga
2021-04-07T12:08:04Z

On 2021-04-07 11:39, Mauro Carvalho Chehab wrote:
> Em Wed, 7 Apr 2021 10:52:14 +0200
> Thorsten Leemhuis <linux@leemhuis.info> escreveu:
>
>> On 07.04.21 10:20, Mauro Carvalho Chehab wrote:
>> > Changeset d2ce285378b0 ("docs: make reporting-issues.rst official and delete reporting-bugs.rst")
>> > dropped reporting-bugs.rst, in favor of reporting-issues.rst, but
>> > translations still need to be updated, in order to point to the
>> > new file.
>> >
>> > Fixes: d2ce285378b0 ("docs: make reporting-issues.rst official and delete reporting-bugs.rst")
>> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>>
>> Well, yeah, might be the right thing to do. But FWIW: when I recently
>> submitted the change that became d2ce285378b0 I actually pointed out
>> that it breaks some of the translations. Back then I considered to do
>> what you did with this patch, but among others got a reply from
>> Jonathan
>> who said "let the translators catch up on their own time". For details
>> see this thread:
>> https://lore.kernel.org/linux-doc/87h7krksvu.fsf@meer.lwn.net/
>
> Hmm... at the e-mail you mentioned, Jon commented that:
>
> "None of the broken references actually generate warnings"

I take the occasion to highlight it.

If there are trivial fixes due to broken references introduced by a
patch, then fixing the translation is recommended (as you fix all
instances of a function if you change its arguments), and you do not
need to know the target language to do it. Any other change to the text
body is left to translators.

> That's actually not the case: they do generate warnings if
> the Kernel is built with CONFIG_WARN_MISSING_DOCUMENTS:
>
> Documentation/translations/zh_CN/admin-guide/reporting-issues.rst:
> Documentation/admin-guide/reporting-bugs.rst
> Documentation/translations/zh_CN/admin-guide/reporting-issues.rst:
> Documentation/admin-guide/reporting-bugs.rst
>
> As it will call the ./scripts/documentation-file-ref-check.
>
> That's basically why I detected and submitted a fix ;-)
>
> Thanks,
> Mauro

--
Federico Vaga