2023-09-05 16:22:30

by Min-Hua Chen

[permalink] [raw]
Subject: [PATCH v3 0/3] convert TW translation sparse.txt to RST

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/[email protected]/
[2] https://lore.kernel.org/lkml/[email protected]/



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%)

---

Change since v1:
1. change subject to convert sparse.txt to RST
2. add Suggested-by tag to credit Randy

Change since v2:
rebase to next-20230831

--
2.34.1


2023-10-03 16:27:04

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v3 0/3] convert TW translation sparse.txt to RST

Min-Hua Chen <[email protected]> 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/[email protected]/
> [2] https://lore.kernel.org/lkml/[email protected]/
>
>
>
> 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

2023-10-03 23:41:00

by Min-Hua Chen

[permalink] [raw]
Subject: Re: [PATCH v3 0/3] convert TW translation sparse.txt to RST

>> 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

Got it, thank you for doing this.
I will do build-test with care in the future.

Min-Hua