doc/zh_CN: add Chinese document coding style reminder
authorAlex Shi <alexs@kernel.org>
Thu, 9 Dec 2021 09:56:04 +0000 (17:56 +0800)
committerJonathan Corbet <corbet@lwn.net>
Fri, 10 Dec 2021 21:00:25 +0000 (14:00 -0700)
The coding style requirement for Chinese document is easy to be overlooked.
Add the request as a remdiner.

Signed-off-by: Alex Shi <alexs@kernel.org>
Cc: Yanteng Si <siyanteng01@gmail.com>
Cc: Tang Yizhou <tangyizhou@huawei.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Link: https://lore.kernel.org/r/20211209095604.68954-1-alexs@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/translations/zh_CN/index.rst

index aebe336..46e14ec 100644 (file)
 另外,随时欢迎您对内核文档进行改进;如果您想提供帮助,请加入vger.kernel.org
 上的linux-doc邮件列表。
 
+顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
+的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
+中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。在将
+补丁提交到社区之前,一定要进行必要的checkpatch.pl检查和编译测试。
+
 许可证文档
 ----------