From: alexs@kernel.org
To: unlisted-recipients:; (no To-header on input)
Cc: Alex Shi <alexs@kernel.org>, Yanteng Si <siyanteng01@gmail.com>,
Tang Yizhou <tangyizhou@huawei.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2] doc/zh_CN: add Chinese document coding style reminder
Date: Thu, 9 Dec 2021 17:56:04 +0800 [thread overview]
Message-ID: <20211209095604.68954-1-alexs@kernel.org> (raw)
From: Alex Shi <alexs@kernel.org>
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
---
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
next reply other threads:[~2021-12-09 9:56 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-09 9:56 alexs [this message]
2021-12-10 2:42 ` [PATCH v2] doc/zh_CN: add Chinese document coding style reminder yanteng si
2021-12-10 21:00 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211209095604.68954-1-alexs@kernel.org \
--to=alexs@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=siyanteng01@gmail.com \
--cc=tangyizhou@huawei.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).