summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorAlex Shi <alexs@kernel.org>2021-12-09 10:56:04 +0100
committerJonathan Corbet <corbet@lwn.net>2021-12-10 22:00:25 +0100
commit4fd34f8e1ff70cd7f86e18deb20be35f4605f5f6 (patch)
tree95349ea2b9bfca983ba36aee9d66745c29ca1ad5 /Documentation
parentdocs/trace: fix a label of boottime-trace (diff)
downloadlinux-4fd34f8e1ff70cd7f86e18deb20be35f4605f5f6.tar.xz
linux-4fd34f8e1ff70cd7f86e18deb20be35f4605f5f6.zip
doc/zh_CN: add Chinese document coding style reminder
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>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/translations/zh_CN/index.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
index aebe336ab538..46e14ec9963d 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检查和编译测试。
+
许可证文档
----------