2021-04-07 20:34:13

by Mauro Carvalho Chehab

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

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 <[email protected]>
---
Documentation/translations/it_IT/process/howto.rst | 2 +-
Documentation/translations/ja_JP/howto.rst | 2 +-
Documentation/translations/zh_CN/SecurityBugs | 2 +-
.../translations/zh_CN/admin-guide/reporting-issues.rst | 4 ++--
Documentation/translations/zh_CN/process/howto.rst | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/translations/it_IT/process/howto.rst b/Documentation/translations/it_IT/process/howto.rst
index 1db5a1082389..4962057f50fa 100644
--- a/Documentation/translations/it_IT/process/howto.rst
+++ b/Documentation/translations/it_IT/process/howto.rst
@@ -364,7 +364,7 @@ Per maggiori dettagli su come usare il bugzilla del kernel, guardare:

https://bugzilla.kernel.org/page.cgi?id=faq.html

-Il file admin-guide/reporting-bugs.rst nella cartella principale del kernel
+Il file admin-guide/reporting-issues.rst nella cartella principale del kernel
fornisce un buon modello sul come segnalare un baco nel kernel, e spiega quali
informazioni sono necessarie agli sviluppatori per poter aiutare il
rintracciamento del problema.
diff --git a/Documentation/translations/ja_JP/howto.rst b/Documentation/translations/ja_JP/howto.rst
index 73ebdab4ced7..3051ff787e69 100644
--- a/Documentation/translations/ja_JP/howto.rst
+++ b/Documentation/translations/ja_JP/howto.rst
@@ -367,7 +367,7 @@ kernel bugzilla を使うかの詳細は、以下を参照してください -
https://bugzilla.kernel.org/page.cgi?id=faq.html

メインカーネルソースディレクトリにあるファイル
-admin-guide/reporting-bugs.rstはカーネルバグらしいものについてどうレポー
+admin-guide/reporting-issues.rstはカーネルバグらしいものについてどうレポー
トするかの良いテンプレートであり、問題の追跡を助けるためにカーネル開発
者にとってどんな情報が必要なのかの詳細が書かれています。

diff --git a/Documentation/translations/zh_CN/SecurityBugs b/Documentation/translations/zh_CN/SecurityBugs
index 2d0fffd122ce..980199d88eca 100644
--- a/Documentation/translations/zh_CN/SecurityBugs
+++ b/Documentation/translations/zh_CN/SecurityBugs
@@ -31,7 +31,7 @@ linux内核安全团队可以通过email<[email protected]>来联系。这是
一组独立的安全工作人员,可以帮助改善漏洞报告并且公布和取消一个修复。安
全团队有可能会从部分的维护者那里引进额外的帮助来了解并且修复安全漏洞。
当遇到任何漏洞,所能提供的信息越多就越能诊断和修复。如果你不清楚什么
-是有帮助的信息,那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任
+是有帮助的信息,那就请重温一下admin-guide/reporting-issues.rst文件中的概述过程。任
何攻击性的代码都是非常有用的,未经报告者的同意不会被取消,除非它已经
被公布于众。

diff --git a/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst b/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst
index 2805c1a03cd5..72c8e2db88c0 100644
--- a/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst
+++ b/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst
@@ -19,7 +19,7 @@

.. important::

- 本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作
+ 本文档将取代“Documentation/admin-guide/reporting-issues.rst”。主要的工作
已经完成,你可以自由地按照其指示来向Linux内核开发者报告问题。但请留意,
下面的文字还需要一些润色和校审。现阶段它被合并到Linux内核源代码中,以使
这个过程更容易,并增加文本的可见性。
@@ -726,7 +726,7 @@ tar 存档包。
.. note::

FIXME: 本节文字暂时是占位符,与目前
- “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它
+ “Documentation/admin-guide/reporting-issues.rst”中的旧文字非常相似。它和它
所引用的文档已经过时,因此需要重新审视。因此,请将此说明视为一个求助:如
果你熟悉这个主题,请写几行适合这里的文字。或者只需向本文件的主要作者(见
导言)大致概述一下当前的情况,因为他们也许能写出一些东西来。
diff --git a/Documentation/translations/zh_CN/process/howto.rst b/Documentation/translations/zh_CN/process/howto.rst
index ee3dee476d57..c87cd529d769 100644
--- a/Documentation/translations/zh_CN/process/howto.rst
+++ b/Documentation/translations/zh_CN/process/howto.rst
@@ -280,7 +280,7 @@ bugzilla.kernel.org是Linux内核开发者们用来跟踪内核Bug的网站。

http://test.kernel.org/bugzilla/faq.html

-内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
+内核源码主目录中的:ref:`admin-guide/reporting-issues.rst <reportingbugs>`
文件里有一个很好的模板。它指导用户如何报告可能的内核bug以及需要提供哪些信息
来帮助内核开发者们找到问题的根源。

--
2.30.2


2021-04-07 20:36:58

by Thorsten Leemhuis

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

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 <[email protected]>

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/[email protected]/

Ciao, Thorsten

2021-04-07 20:43:57

by Wu XiangCheng

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

On Wed, Apr 07, 2021 at 10:20:56AM +0200, 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 <[email protected]>
> ---
> Documentation/translations/it_IT/process/howto.rst | 2 +-
> Documentation/translations/ja_JP/howto.rst | 2 +-
> Documentation/translations/zh_CN/SecurityBugs | 2 +-
> .../translations/zh_CN/admin-guide/reporting-issues.rst | 4 ++--
> Documentation/translations/zh_CN/process/howto.rst | 2 +-
> 5 files changed, 6 insertions(+), 6 deletions(-)
>
[...]

Hi Mauro,

Thanks to help us!

For zh translation:

> diff --git a/Documentation/translations/zh_CN/SecurityBugs b/Documentation/translations/zh_CN/SecurityBugs

This file is very old, may be removed soon.
No need to edit it.

> index 2d0fffd122ce..980199d88eca 100644
> --- a/Documentation/translations/zh_CN/SecurityBugs
> +++ b/Documentation/translations/zh_CN/SecurityBugs
> @@ -31,7 +31,7 @@ linux内核安全团队可以通过email<[email protected]>来联系。这是
> 一组独立的安全工作人员,可以帮助改善漏洞报告并且公布和取消一个修复。安
> 全团队有可能会从部分的维护者那里引进额外的帮助来了解并且修复安全漏洞。
> 当遇到任何漏洞,所能提供的信息越多就越能诊断和修复。如果你不清楚什么
> -是有帮助的信息,那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任
> +是有帮助的信息,那就请重温一下admin-guide/reporting-issues.rst文件中的概述过程。任
> 何攻击性的代码都是非常有用的,未经报告者的同意不会被取消,除非它已经
> 被公布于众。
>
> diff --git a/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst b/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst

The link here could not be simply replaced, the means is wrong.
I will sync reporting-issues.rst with new verison in future.

> index 2805c1a03cd5..72c8e2db88c0 100644
> --- a/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst
> +++ b/Documentation/translations/zh_CN/admin-guide/reporting-issues.rst
> @@ -19,7 +19,7 @@
>
> .. important::
>
> - 本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作
> + 本文档将取代“Documentation/admin-guide/reporting-issues.rst”。主要的工作
> 已经完成,你可以自由地按照其指示来向Linux内核开发者报告问题。但请留意,
> 下面的文字还需要一些润色和校审。现阶段它被合并到Linux内核源代码中,以使
> 这个过程更容易,并增加文本的可见性。
> @@ -726,7 +726,7 @@ tar 存档包。
> .. note::
>
> FIXME: 本节文字暂时是占位符,与目前
> - “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它
> + “Documentation/admin-guide/reporting-issues.rst”中的旧文字非常相似。它和它
> 所引用的文档已经过时,因此需要重新审视。因此,请将此说明视为一个求助:如
> 果你熟悉这个主题,请写几行适合这里的文字。或者只需向本文件的主要作者(见
> 导言)大致概述一下当前的情况,因为他们也许能写出一些东西来。
> diff --git a/Documentation/translations/zh_CN/process/howto.rst b/Documentation/translations/zh_CN/process/howto.rst

This change is ok.

> index ee3dee476d57..c87cd529d769 100644
> --- a/Documentation/translations/zh_CN/process/howto.rst
> +++ b/Documentation/translations/zh_CN/process/howto.rst
> @@ -280,7 +280,7 @@ bugzilla.kernel.org是Linux内核开发者们用来跟踪内核Bug的网站。
>
> http://test.kernel.org/bugzilla/faq.html
>
> -内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
> +内核源码主目录中的:ref:`admin-guide/reporting-issues.rst <reportingbugs>`
> 文件里有一个很好的模板。它指导用户如何报告可能的内核bug以及需要提供哪些信息
> 来帮助内核开发者们找到问题的根源。
>
> --
> 2.30.2

Thanks!

Wu X.C.

2021-04-07 20:44:09

by Mauro Carvalho Chehab

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

Em Wed, 7 Apr 2021 10:52:14 +0200
Thorsten Leemhuis <[email protected]> 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 <[email protected]>
>
> 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/[email protected]/

Hmm... at the e-mail you mentioned, Jon commented that:

"None of the broken references actually generate warnings"

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

2021-04-07 20:57:14

by Federico Vaga

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

On 2021-04-07 11:39, Mauro Carvalho Chehab wrote:
> Em Wed, 7 Apr 2021 10:52:14 +0200
> Thorsten Leemhuis <[email protected]> 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 <[email protected]>
>>
>> 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/[email protected]/
>
> 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
http://www.federicovaga.it/

2021-04-07 20:57:14

by Federico Vaga

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

On 2021-04-07 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 <[email protected]>
> ---
> Documentation/translations/it_IT/process/howto.rst | 2 +-

Acked-by: Federico Vaga <[email protected]>

> Documentation/translations/ja_JP/howto.rst | 2 +-
> Documentation/translations/zh_CN/SecurityBugs | 2 +-
> .../translations/zh_CN/admin-guide/reporting-issues.rst | 4 ++--
> Documentation/translations/zh_CN/process/howto.rst | 2 +-
> 5 files changed, 6 insertions(+), 6 deletions(-)

--
Federico Vaga
http://www.federicovaga.it/