linux-kernel - Re: [PATCH 2/2] docs: sparse: convert TW sparse.txt into sparse.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87a5uxxqf3.fsf@meer.lwn.net>
Date:   Fri, 11 Aug 2023 14:41:36 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Min-Hua Chen <minhuadotchen@...il.com>,
        Hu Haowen <src.res@...il.cn>
Cc:     Min-Hua Chen <minhuadotchen@...il.com>,
        Randy Dunlap <rdunlap@...radead.org>,
        linux-doc-tw-discuss@...ts.sourceforge.net,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 2/2] docs: sparse: convert TW sparse.txt into sparse.rst

Min-Hua Chen <minhuadotchen@...il.com> writes:

> Follow Randy's advice [1] to move
> Documentation/translations/zh_TW/dev-tools/sparse.txt
> to
> Documentation/translations/zh_TW/dev-tools/sparse.rst
>
> [1] https://lore.kernel.org/lkml/bfab7c5b-e4d3-d8d9-afab-f43c0cdf26cf@infradead.org/

So the right way to do this would be to simply say something like
"Convert sparse.txt to RST", then add a Suggested-by: tag to credit
Randy. 

> Cc: Randy Dunlap <rdunlap@...radead.org>
> Signed-off-by: Min-Hua Chen <minhuadotchen@...il.com>
> ---
>  .../dev-tools/{sparse.txt => sparse.rst}      | 31 ++++++-------------
>  1 file changed, 10 insertions(+), 21 deletions(-)
>  rename Documentation/translations/zh_TW/dev-tools/{sparse.txt => sparse.rst} (71%)

You're not adding this new document to a toctree anywhere; that will add
a warning and this file won't be a part of the docs build.

> diff --git a/Documentation/translations/zh_TW/dev-tools/sparse.txt b/Documentation/translations/zh_TW/dev-tools/sparse.rst
> similarity index 71%
> rename from Documentation/translations/zh_TW/dev-tools/sparse.txt
> rename to Documentation/translations/zh_TW/dev-tools/sparse.rst
> index 6d2d088b1060..2f632f6ce8e8 100644
> --- a/Documentation/translations/zh_TW/dev-tools/sparse.txt
> +++ b/Documentation/translations/zh_TW/dev-tools/sparse.rst
> @@ -1,33 +1,22 @@
> -Chinese translated version of Documentation/dev-tools/sparse.rst
> -
> -If you have any comment or update to the content, please contact the
> -original document maintainer directly.  However, if you have a problem
> -communicating in English you can also ask the Chinese maintainer for
> -help.  Contact the Chinese maintainer if this translation is outdated
> -or if there is a problem with the translation.
> +Copyright 2004 Linus Torvalds
> +Copyright 2004 Pavel Machek <pavel@....cz>
> +Copyright 2006 Bob Copeland <me@...copeland.com>
>  
> -Traditional Chinese maintainer: Hu Haowen <src.res@...il.cn>
> ----------------------------------------------------------------------
> -Documentation/dev-tools/sparse.rst 的繁體中文翻譯
> +.. include:: ../disclaimer-zh_TW.rst
>  
> -如果想評論或更新本文的內容，請直接聯繫原文檔的維護者。如果你使用英文
> -交流有困難的話，也可以向繁體中文版維護者求助。如果本翻譯更新不及時或
> -者翻譯存在問題，請聯繫繁體中文版維護者。
> +:Original: Documentation/dev-tools/sparse.rst
>  
> -繁體中文版維護者： 胡皓文 Hu Haowen <src.res@...il.cn>
> -繁體中文版翻譯者： 胡皓文 Hu Haowen <src.res@...il.cn>
> +:翻譯:

So you are removing a fair amount of text here, much of which I cannot
read.  Why are you doing that?  In any case, that would appear to be a
change that is independent of the format conversion, and should thus be
in its own patch.

Thanks,

jon