Re: [RFC PATCH] doc: translation disclaimer

Federico Vaga
2019-03-11T21:02:07Z

On 2019-03-07 05:03, Alex Shi wrote:
> On 2019/3/6 11:17 下午, Federico Vaga wrote:
>
>> As I wrote in the commit message, this is just a example to show
>> the
>> structure and share the main message.
>>
>> What I wrote is just a 10 minutes sketch, to share an idea. This is
>> **not**
>> the text that I'm proposing; what I'm proposing here are the
>> structure and the
>> concepts/ideas/messages. The final patch will be written
>> appropriately, but
>> before doing it I would like to collect the messages that we want to
>> put in
>> it; I listed above what I think is necessary to say.
>
> Got it. yes, it's a good idea, and we'd better figure out the more
> elegant, precise and legally words. :)

I wouldn't go that far with the legal jargon. There is nothing legal
about
this, only that who read a translation must be aware of its limitations.

>> +
>> +Translations
>> +------------
>> +
>>
>> .. toctree::
>> :maxdepth: 1
>>
>> diff --git a/Documentation/translations/it_IT/disclaimer-ita.rst
>> b/Documentation/translations/it_IT/disclaimer-ita.rst index
>> d68e52de6a5d..aacc1a0346db 100644
>> --- a/Documentation/translations/it_IT/disclaimer-ita.rst
>> +++ b/Documentation/translations/it_IT/disclaimer-ita.rst
>> @@ -1,13 +1,6 @@
>>
>> :orphan:
>>
>> why the orphan here? does that mean no maintainer for it_IT
>> currently?
>
> It is a Sphinx tag to avoid warnings at build time. Instead of
> re-writing
> exactly the same text in all files, this one is included at the top of
> all
> translated documents. But, since it is not a real document this is not
>
> included in any TOC and sphinx complains; that's why we need the
> orphan tag
>
> http://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#metadata
>
> Thanks a lot for the explanations! :)

--
Federico Vaga