[PATCH] doc/zh_CN: add Chinese document coding style reminder

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Alex Shi <alexs@xxxxxxxxxx>

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

Signed-off-by: Alex Shi <alexs@xxxxxxxxxx>
Cc: Yanteng Si <siyanteng01@xxxxxxxxx>
Cc: Tang Yizhou <tangyizhou@xxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx> 
Cc: linux-doc@xxxxxxxxxxxxxxx 
Cc: linux-kernel@xxxxxxxxxxxxxxx 
---
 Documentation/translations/zh_CN/index.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
index a34e58733ac8..8c2786ed0279 100644
--- a/Documentation/translations/zh_CN/index.rst
+++ b/Documentation/translations/zh_CN/index.rst
@@ -23,6 +23,10 @@
 另外,随时欢迎您对内核文档进行改进;如果您想提供帮助,请加入vger.kernel.org
 上的linux-doc邮件列表。
 
+顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
+的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
+中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。
+
 许可证文档
 ----------
 
-- 
2.27.0




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux