[PATCH] doc: add translation disclaimer

[PATCH] doc: add translation disclaimer

[Federico Vaga]

Add the translation disclaimer in English as reference
for other languages.  Translations must include this disclaimer
in their language so that readers are properly informed.

This very same patch updates the Italian translation accordingly.

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
---
 Documentation/translations/index.rst          | 42 ++++++++++++++
 .../translations/it_IT/disclaimer-ita.rst     | 13 +----
 Documentation/translations/it_IT/index.rst    | 57 +++++++++++++------
 3 files changed, 85 insertions(+), 27 deletions(-)

diff --git a/Documentation/translations/index.rst b/Documentation/translations/index.rst
index 7f77c52d33aa..d7a38fd28b50 100644
--- a/Documentation/translations/index.rst
+++ b/Documentation/translations/index.rst
@@ -4,6 +4,48 @@
 Translations
 ============
 
+.. _translations_disclaimer:
+
+Disclaimer
+----------
+
+Translation's purpose is to ease reading and understating in languages other
+than English. Its aim is to help people who do not understand English or have
+doubts about its interpretation. Additionally, some people prefer to read
+documentation in their native language, but please bear in mind that the
+*only* official documentation is the English one: :ref:`linux_doc`.
+
+It is very unlikely that an update to :ref:`linux_doc` will be propagated
+immediately to all translations.  Translations' maintainers - and
+contributors - follow the evolution of the official documentation and they
+maintain translations aligned as much as they can.  For this reason there is
+no guarantee that a translation is up to date.  If what you read in a
+translation does not sound right compared to what you read in the code, please
+inform the translation maintainer and - if you can - check also the English
+documentation.
+
+A translation is not a fork of the official documentation, therefore
+translations' users should not find information that differs from the official
+English documentation.  Any content addition, removal or update, must be
+applied to the English documents first.  Afterwards and when possible, the
+same change should be applied to translations.  Translations' maintainers
+accept only contributions that are merely translation related (e.g. new
+translations, updates, fixes).
+
+Translations try to be as accurate as possible but it is not possible to map
+one language directly to all other languages. Each language has its own
+grammar and culture, so the translation of an English statement may need to be
+adapted to fit a different language.  For this reason, when viewing
+translations, you may find slight differences that carry the same message but
+in a different form.
+
+If you need to communicate with the Linux community but you do not feel
+comfortable to write in English, you can ask to the translation's
+maintainers for help.
+
+Translations
+------------
+
 .. toctree::
    :maxdepth: 1
 
diff --git a/Documentation/translations/it_IT/disclaimer-ita.rst b/Documentation/translations/it_IT/disclaimer-ita.rst
index d68e52de6a5d..bfe8a384baed 100644
--- a/Documentation/translations/it_IT/disclaimer-ita.rst
+++ b/Documentation/translations/it_IT/disclaimer-ita.rst
@@ -1,13 +1,6 @@
 :orphan:
 
-.. note::
-   This document is maintained by Federico Vaga <federico.vaga@vaga.pv.it>.
-   If you find any difference between this document and the original file or a
-   problem with the translation, please contact the maintainer of this file.
-   Following people helped to translate or review:
-   Alessia Mantegazza <amantegazza@vaga.pv.it>
-
 .. warning::
-   The purpose of this file is to be easier to read and understand for Italian
-   speakers and is not intended as a fork. So, if you have any comments or
-   updates for this file please try to update the original English file first.
+   In caso di dubbi sulla correttezza del contenuto di questa traduzione,
+   l'unico riferimento valido è la documentazione ufficiale in inglese.
+   Per maggiori informazioni consultate le :ref:`avvertenze <it_disclaimer>`.
diff --git a/Documentation/translations/it_IT/index.rst b/Documentation/translations/it_IT/index.rst
index 02432b97a43e..409eaac03e9f 100644
--- a/Documentation/translations/it_IT/index.rst
+++ b/Documentation/translations/it_IT/index.rst
@@ -4,26 +4,49 @@
 Traduzione italiana
 ===================
 
-L'obiettivo di questa traduzione è di rendere più facile la lettura e
-la comprensione per chi preferisce leggere in lingua italiana.
-Tenete presente che la documentazione di riferimento rimane comunque
-quella in lingua inglese: :ref:`linux_doc`
-
-Questa traduzione cerca di essere il più fedele possibile all'originale ma
-è ovvio che alcune frasi vadano trasformate: non aspettatevi una traduzione
-letterale. Quando possibile, si eviteranno gli inglesismi ed al loro posto
-verranno utilizzate le corrispettive parole italiane.
+:manutentore: Federico Vaga <federico.vaga@vaga.pv.it>
 
-Se notate che la traduzione non è più aggiornata potete contattare
-direttamente il manutentore della traduzione italiana.
+.. _it_disclaimer:
 
-Se notate che la documentazione contiene errori o dimenticanze, allora
-verificate la documentazione di riferimento in lingua inglese. Se il problema
-è presente anche nella documentazione di riferimento, contattate il suo
-manutentore. Se avete problemi a scrivere in inglese, potete comunque
-riportare il problema al manutentore della traduzione italiana.
+Avvertenze
+==========
 
-Manutentore della traduzione italiana: Federico Vaga <federico.vaga@vaga.pv.it>
+L'obiettivo di questa traduzione è di rendere più facile la lettura e
+la comprensione per chi non capisce l'inglese o ha dubbi sulla sua
+interpretazione, oppure semplicemente per chi preferisce leggere in lingua
+italiana. Tuttavia, tenete ben presente che l'*unica* documentazione
+ufficiale è quella in lingua inglese: :ref:`linux_doc`
+
+La propagazione simultanea a tutte le traduzioni di una modifica in
+:ref:`linux_doc` è altamente improbabile. I manutentori delle traduzioni -
+e i contributori - seguono l'evolversi della documentazione ufficiale e
+cercano di mantenere le rispettive traduzioni allineate nel limite del
+possibile.  Per questo motivo non c'è garanzia che una traduzione sia
+aggiornata all'ultima modifica.  Se quello che leggete in una traduzione
+non corrisponde a quello che leggete nel codice, informate il manutentore
+della traduzione e - se potete - verificate anche la documentazione in
+inglese.
+
+Una traduzione non è un *fork* della documentazione ufficiale, perciò gli
+utenti non vi troveranno alcuna informazione diversa rispetto alla versione
+ufficiale.  Ogni aggiunta, rimozione o modifica dei contenuti deve essere
+fatta prima nei documenti in inglese. In seguito, e quando è possibile, la
+stessa modifica dovrebbe essere applicata anche alle traduzioni.  I manutentori
+delle traduzioni accettano contributi che interessano prettamente l'attività
+di traduzione (per esempio, nuove traduzioni, aggiornamenti, correzioni).
+
+Le traduzioni cercano di essere il più possibile accurate ma non è possibile
+mappare direttamente una lingua in un'altra. Ogni lingua ha la sua grammatica
+e una sua cultura alle spalle, quindi la traduzione di una frase in inglese
+potrebbe essere modificata per adattarla all'italiano. Per questo motivo,
+quando leggete questa traduzione, potreste trovare alcune differenze di forma
+ma che trasmettono comunque il messaggio originale.  Nonostante la grande
+diffusione di inglesismi nella lingua parlata, quando possibile, questi
+verranno sostituiti dalle corrispettive parole italiane
+
+Se avete bisogno d'aiuto per comunicare con la comunità Linux ma non vi sentite
+a vostro agio nello scrivere in inglese, potete chiedere aiuto al manutentore
+della traduzione.
 
 La documentazione del kernel Linux
 ==================================
-- 
2.20.1

Re: [PATCH] doc: add translation disclaimer

[Alex Shi]

On 2019/3/15 4:45 上午, Federico Vaga wrote:
> Add the translation disclaimer in English as reference
> for other languages.  Translations must include this disclaimer
> in their language so that readers are properly informed.
>
> This very same patch updates the Italian translation accordingly.
>
> Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
> ---
>  Documentation/translations/index.rst          | 42 ++++++++++++++
>  .../translations/it_IT/disclaimer-ita.rst     | 13 +----
>  Documentation/translations/it_IT/index.rst    | 57 +++++++++++++------
>  3 files changed, 85 insertions(+), 27 deletions(-)
>
> diff --git a/Documentation/translations/index.rst b/Documentation/translations/index.rst
> index 7f77c52d33aa..d7a38fd28b50 100644
> --- a/Documentation/translations/index.rst
> +++ b/Documentation/translations/index.rst
This part looks good for me. I don't understand Italian. :)

Cheers
Alex

Re: [PATCH] doc: add translation disclaimer

[Federico Vaga]

On Friday, March 15, 2019 6:49:55 AM CET Alex Shi wrote:
> On 2019/3/15 4:45 上午, Federico Vaga wrote:
> > Add the translation disclaimer in English as reference
> > for other languages.  Translations must include this disclaimer
> > in their language so that readers are properly informed.
> > 
> > This very same patch updates the Italian translation accordingly.
> > 
> > Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
> > ---
> > 
> >  Documentation/translations/index.rst          | 42 ++++++++++++++
> >  .../translations/it_IT/disclaimer-ita.rst     | 13 +----
> >  Documentation/translations/it_IT/index.rst    | 57 +++++++++++++------
> >  3 files changed, 85 insertions(+), 27 deletions(-)
> > 
> > diff --git a/Documentation/translations/index.rst
> > b/Documentation/translations/index.rst index 7f77c52d33aa..d7a38fd28b50
> > 100644
> > --- a/Documentation/translations/index.rst
> > +++ b/Documentation/translations/index.rst
> 
> This part looks good for me. I don't understand Italian. :)

The idea is that you (or someone who knows Chinese) translate that disclaimer 
from English to Chinese and put it in the Chinese index.rst page (like I did 
for the Italian one).

Let me write here the translation to English for the disclaimer-ita.rst file 
that I'm including in all documents:

-------
+   In caso di dubbi sulla correttezza del contenuto di questa traduzione,
+   l'unico riferimento valido è la documentazione ufficiale in inglese.
+   Per maggiori informazioni consultate le :ref:`avvertenze <it_disclaimer>`.

If you have any doubt about the content of this translation, the only valid 
reference is the English official documentation. For more information please 
read :ref:`disclaimer <it_disclaimer>`
-------

The idea is the have a quick warning that points you to the full disclaimer.


> 
> Cheers
> Alex


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

Re: [PATCH] doc: add translation disclaimer

[Rasmus Villemoes]

On 14/03/2019 21.45, Federico Vaga wrote:
> 
> diff --git a/Documentation/translations/index.rst b/Documentation/translations/index.rst
> index 7f77c52d33aa..d7a38fd28b50 100644
> --- a/Documentation/translations/index.rst
> +++ b/Documentation/translations/index.rst
> @@ -4,6 +4,48 @@
>  Translations
>  ============
>  
> +.. _translations_disclaimer:
> +
> +Disclaimer
> +----------
> +
> +Translation's purpose is to ease reading and understating in languages other

understanding, hopefully :)

> +If you need to communicate with the Linux community but you do not feel
> +comfortable to write in English, you can ask to the translation's
> +maintainers for help.
> +

s/to write/writing/, s/ask to/ask/

> +Translations
> +------------
> +

Do you really mean to add that heading a second time? I know it's on
another level, but it seems a bit odd.

Rasmus

Re: [PATCH] doc: add translation disclaimer

[Federico Vaga]

On Friday, March 15, 2019 11:00:57 AM CET Rasmus Villemoes wrote:
> On 14/03/2019 21.45, Federico Vaga wrote:
> > diff --git a/Documentation/translations/index.rst
> > b/Documentation/translations/index.rst index 7f77c52d33aa..d7a38fd28b50
> > 100644
> > --- a/Documentation/translations/index.rst
> > +++ b/Documentation/translations/index.rst
> > @@ -4,6 +4,48 @@
> > 
> >  Translations
> >  ============
> > 
> > +.. _translations_disclaimer:
> > +
> > +Disclaimer
> > +----------
> > +
> > +Translation's purpose is to ease reading and understating in languages
> > other
> understanding, hopefully :)

ops, yes :D

> 
> > +If you need to communicate with the Linux community but you do not feel
> > +comfortable to write in English, you can ask to the translation's
> > +maintainers for help.
> > +
> 
> s/to write/writing/, s/ask to/ask/

ack
 
> > +Translations
> > +------------
> > +
> 
> Do you really mean to add that heading a second time? I know it's on
> another level, but it seems a bit odd.

You are right

> 
> Rasmus


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

Re: [PATCH] doc: add translation disclaimer

[Federico Vaga]

On 2019-03-15 06:49, Alex Shi wrote:
> On 2019/3/15 4:45 上午, Federico Vaga wrote:
>> Add the translation disclaimer in English as reference
>> for other languages.  Translations must include this disclaimer
>> in their language so that readers are properly informed.
>> 
>> This very same patch updates the Italian translation accordingly.
>> 
>> Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
>> ---
>>  Documentation/translations/index.rst          | 42 ++++++++++++++
>>  .../translations/it_IT/disclaimer-ita.rst     | 13 +----
>>  Documentation/translations/it_IT/index.rst    | 57 
>> +++++++++++++------
>>  3 files changed, 85 insertions(+), 27 deletions(-)
>> 
>> diff --git a/Documentation/translations/index.rst 
>> b/Documentation/translations/index.rst
>> index 7f77c52d33aa..d7a38fd28b50 100644
>> --- a/Documentation/translations/index.rst
>> +++ b/Documentation/translations/index.rst
> This part looks good for me. I don't understand Italian. :)

I forgot to ask you if "looks good for me" means:

Acked-by: Alex Shi <alex.shi@linux.alibaba.com>

> Cheers
> Alex

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

Re: [PATCH] doc: add translation disclaimer

[Jonathan Corbet]

On Thu, 14 Mar 2019 21:45:16 +0100
Federico Vaga <federico.vaga@vaga.pv.it> wrote:

> Add the translation disclaimer in English as reference
> for other languages.  Translations must include this disclaimer
> in their language so that readers are properly informed.
> 
> This very same patch updates the Italian translation accordingly.
> 
> Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>

Honestly, it all feels a little too legalistic to me; have people been
worried about the translations in this regard?

Oh well, I went ahead and applied it.  I do think that it might make sense
to move the TOC *above* the disclaimer, though, since that's what readers
are really going to be interested in.

Thanks,

jon

Re: [PATCH] doc: add translation disclaimer

[Federico Vaga]

On Monday, March 18, 2019 6:35:34 PM CET Jonathan Corbet wrote:
> On Thu, 14 Mar 2019 21:45:16 +0100
> 
> Federico Vaga <federico.vaga@vaga.pv.it> wrote:
> > Add the translation disclaimer in English as reference
> > for other languages.  Translations must include this disclaimer
> > in their language so that readers are properly informed.
> > 
> > This very same patch updates the Italian translation accordingly.
> > 
> > Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
> 
> Honestly, it all feels a little too legalistic to me; have people been
> worried about the translations in this regard?
> 
> Oh well, I went ahead and applied it.  I do think that it might make sense
> to move the TOC *above* the disclaimer, though, since that's what readers
> are really going to be interested in.

No, problem I can do it and send a new version

> 
> Thanks,
> 
> jon


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

Re: [PATCH] doc: add translation disclaimer

[Jonathan Corbet]

On Tue, 19 Mar 2019 09:03:53 +0100
Federico Vaga <federico.vaga@vaga.pv.it> wrote:

> > Oh well, I went ahead and applied it.  I do think that it might make sense
> > to move the TOC *above* the disclaimer, though, since that's what readers
> > are really going to be interested in.  
> 
> No, problem I can do it and send a new version

Note that I said I applied the patch, so "a new version" isn't quite
what's needed here.  If you feel so inclined, a patch to reorder that file
would be good, though.

Thanks,

jon

Re: [PATCH] doc: add translation disclaimer

[Federico Vaga]

On Tuesday, March 19, 2019 2:35:39 PM CET Jonathan Corbet wrote:
> On Tue, 19 Mar 2019 09:03:53 +0100
> 
> Federico Vaga <federico.vaga@vaga.pv.it> wrote:
> > > Oh well, I went ahead and applied it.  I do think that it might make
> > > sense
> > > to move the TOC *above* the disclaimer, though, since that's what
> > > readers
> > > are really going to be interested in.
> > 
> > No, problem I can do it and send a new version
> 
> Note that I said I applied the patch, so "a new version" isn't quite
> what's needed here.  

Actually I've sent the V2 patch with fixes suggested by Rasmus Villemoes
before you applied this (V1) patch. And in that patch the TOC is, indeed, 
above.

https://lkml.org/lkml/2019/3/15/714

When I answered you talking about a new version I forgot that it was done 
already (V2 patch above) ^_^'

> If you feel so inclined, a patch to reorder that file
> would be good, though.

I will send a patch that fixes this misunderstanding

> Thanks,
> 
> jon