linux-kernel - Re: [PATCH v3 0/3] convert TW translation sparse.txt to 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: <8734yrekon.fsf@meer.lwn.net>
Date:   Tue, 03 Oct 2023 10:26:48 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Min-Hua Chen <minhuadotchen@...il.com>,
        Hu Haowen <src.res@...il.cn>
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        linux-doc-tw-discuss@...ts.sourceforge.net,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Min-Hua Chen <minhuadotchen@...il.com>
Subject: Re: [PATCH v3 0/3] convert TW translation sparse.txt to RST

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

> These patches move TW sparse.txt to TW dev-tools and
> convert TW sparse.txt to RST, based on [1].
> Add the RST to toctree [2].
>
> Randy said [1]:
> "
> it would be good if someone would update/modify this
> sparse.txt file to be in Documentation/translation/zh_TW/dev-tools/
> and convert it to sparse.rst (IMO).
> "
>
> [1] https://lore.kernel.org/lkml/bfab7c5b-e4d3-d8d9-afab-f43c0cdf26cf@infradead.org/
> [2] https://lore.kernel.org/lkml/87a5uxxqf3.fsf@meer.lwn.net/
>
>
>
> Min-Hua Chen (3):
>   docs: sparse: move TW sparse.txt to TW dev-tools
>   docs: sparse: convert sparse.txt to RST
>   docs: sparse: add sparse.rst to toctree
>
>  .../translations/zh_TW/dev-tools/index.rst    | 40 +++++++++++++++++++
>  .../{sparse.txt => dev-tools/sparse.rst}      |  2 +-
>  Documentation/translations/zh_TW/index.rst    |  2 +-
>  3 files changed, 42 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/translations/zh_TW/dev-tools/index.rst
>  rename Documentation/translations/zh_TW/{sparse.txt => dev-tools/sparse.rst} (99%)

So this series introduces a new warning:

WARNING: Unparseable C cross-reference: 'int'
Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 3]
  int
  ---^

That is ... somewhat unhelpful.  I eventually tracked it down to this
piece in sparse.rst:

> 所以更簡單的辦法只要這樣做：
> 
> 	typedef int __bitwise pm_request_t;
> 
> 	#define PM_SUSPEND ((__force pm_request_t) 1)
> 	#define PM_RESUME ((__force pm_request_t) 2)
> 
> 現在你就有了嚴格的類型檢查所需要的所有基礎架構。

That needs to be a literal block to be parsed properly.  I have taken
the liberty of changing the first line above to:

> 所以更簡單的辦法只要這樣做::

...and the warning is gone.

Thus: series applied, but please properly build-test changes like this
in the future.

Thanks,

jon