Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) client-ip=2620:137:e000::3:5;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Min-Hua Chen <minhuadotchen@gmail.com>,
        Hu Haowen <src.res@email.cn>
Cc:     Randy Dunlap <rdunlap@infradead.org>,
        linux-doc-tw-discuss@lists.sourceforge.net,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        Min-Hua Chen <minhuadotchen@gmail.com>
Subject: Re: [PATCH v3 0/3] convert TW translation sparse.txt to RST
In-Reply-To: <20230902052512.12184-1-minhuadotchen@gmail.com>
References: <20230902052512.12184-1-minhuadotchen@gmail.com>
Date:   Tue, 03 Oct 2023 10:26:48 -0600
Message-ID: <8734yrekon.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

Min-Hua Chen <minhuadotchen@gmail.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@inf=
radead.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 =3D> 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 =3D> dev-tools/spars=
e.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:

> =E6=89=80=E4=BB=A5=E6=9B=B4=E7=B0=A1=E5=96=AE=E7=9A=84=E8=BE=A6=E6=B3=95=
=E5=8F=AA=E8=A6=81=E9=80=99=E6=A8=A3=E5=81=9A=EF=BC=9A
>=20
> 	typedef int __bitwise pm_request_t;
>=20
> 	#define PM_SUSPEND ((__force pm_request_t) 1)
> 	#define PM_RESUME ((__force pm_request_t) 2)
>=20
> =E7=8F=BE=E5=9C=A8=E4=BD=A0=E5=B0=B1=E6=9C=89=E4=BA=86=E5=9A=B4=E6=A0=BC=
=E7=9A=84=E9=A1=9E=E5=9E=8B=E6=AA=A2=E6=9F=A5=E6=89=80=E9=9C=80=E8=A6=81=E7=
=9A=84=E6=89=80=E6=9C=89=E5=9F=BA=E7=A4=8E=E6=9E=B6=E6=A7=8B=E3=80=82

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

> =E6=89=80=E4=BB=A5=E6=9B=B4=E7=B0=A1=E5=96=AE=E7=9A=84=E8=BE=A6=E6=B3=95=
=E5=8F=AA=E8=A6=81=E9=80=99=E6=A8=A3=E5=81=9A::

...and the warning is gone.

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

Thanks,

jon