2021-12-09 09:56:17

by alexs

[permalink] [raw]
Subject: [PATCH v2] doc/zh_CN: add Chinese document coding style reminder

From: Alex Shi <[email protected]>

The coding style requirement for Chinese document is easy to be overlooked.
Add the request as a remdiner.

Signed-off-by: Alex Shi <[email protected]>
Cc: Yanteng Si <[email protected]>
Cc: Tang Yizhou <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
Documentation/translations/zh_CN/index.rst | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
index a34e58733ac8..b01c04227d8a 100644
--- a/Documentation/translations/zh_CN/index.rst
+++ b/Documentation/translations/zh_CN/index.rst
@@ -23,6 +23,11 @@
另外,随时欢迎您对内核文档进行改进;如果您想提供帮助,请加入vger.kernel.org
上的linux-doc邮件列表。

+顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
+的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
+中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。在将
+补丁提交到社区之前,一定要进行必要的checkpatch.pl检查和编译测试。
+
许可证文档
----------

--
2.25.1



2021-12-10 02:42:34

by yanteng si

[permalink] [raw]
Subject: Re: [PATCH v2] doc/zh_CN: add Chinese document coding style reminder

<[email protected]> 于2021年12月9日周四 17:56写道:
>
> From: Alex Shi <[email protected]>
>
> The coding style requirement for Chinese document is easy to be overlooked.
> Add the request as a remdiner.
>
> Signed-off-by: Alex Shi <[email protected]>
> Cc: Yanteng Si <[email protected]>
> Cc: Tang Yizhou <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
Reviewed-by: Yanteng Si <[email protected]>

Thanks,
Yanteng

2021-12-10 21:00:51

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v2] doc/zh_CN: add Chinese document coding style reminder

yanteng si <[email protected]> writes:

> <[email protected]> 于2021年12月9日周四 17:56写道:
>>
>> From: Alex Shi <[email protected]>
>>
>> The coding style requirement for Chinese document is easy to be overlooked.
>> Add the request as a remdiner.
>>
>> Signed-off-by: Alex Shi <[email protected]>
>> Cc: Yanteng Si <[email protected]>
>> Cc: Tang Yizhou <[email protected]>
>> Cc: Jonathan Corbet <[email protected]>
>> Cc: [email protected]
>> Cc: [email protected]
> Reviewed-by: Yanteng Si <[email protected]>

Applied, thanks.

jon