From: Alex Shi <alex.shi@linux.alibaba.com>
To: corbet@lwn.net, harryxiyou@gmail.com, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Cc: Alex Shi <alex.shi@linux.alibaba.com>,
Li Yang <leoyang.li@nxp.com>, TripleX Chung <xxx.phy@gmail.com>
Subject: [PATCH v4 29/31] docs/zh_CN: fix rst format issue in submitting-patch
Date: Tue, 12 Mar 2019 11:01:27 +0800 [thread overview]
Message-ID: <20190312030129.47511-30-alex.shi@linux.alibaba.com> (raw)
In-Reply-To: <20190312030129.47511-1-alex.shi@linux.alibaba.com>
Tame 'make htmldocs' to avoid indent and code section
error complains.
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Li Yang <leoyang.li@nxp.com>
Cc: TripleX Chung <xxx.phy@gmail.com>
---
.../zh_CN/process/submitting-patches.rst | 24 +++++++++++--------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/Documentation/translations/zh_CN/process/submitting-patches.rst b/Documentation/translations/zh_CN/process/submitting-patches.rst
index 47cdca62cfa2..54fe00d0afc1 100644
--- a/Documentation/translations/zh_CN/process/submitting-patches.rst
+++ b/Documentation/translations/zh_CN/process/submitting-patches.rst
@@ -39,7 +39,7 @@ Documentation/process/submitting-drivers.rst 。
参数生成。而且,请使用 '-p' 参数,那样会显示每个改动所在的C函数,使得
产生的补丁容易读得多。补丁应该基于内核源代码树的根目录,而不是里边的任
何子目录。
-为一个单独的文件创建补丁,一般来说这样做就够了:
+为一个单独的文件创建补丁,一般来说这样做就够了::
SRCTREE= linux-2.6
MYFILE= drivers/net/mydriver.c
@@ -51,7 +51,7 @@ Documentation/process/submitting-drivers.rst 。
diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
为多个文件创建补丁,你可以解开一个没有修改过的内核源代码树,然后和你自
-己的代码树之间做 diff 。例如:
+己的代码树之间做 diff 。例如::
MYSRC= /devel/linux-2.6
@@ -141,6 +141,7 @@ MAINTAINERS 文件里的)发送一个手册页(man-pages)补丁,或者
对于小的补丁,你也许会CC到 Adrian Bunk 管理的搜集琐碎补丁的邮件列表
(Trivial Patch Monkey)trivial@kernel.org,那里专门收集琐碎的补丁。下面这样
的补丁会被看作“琐碎的”补丁:
+
文档的拼写修正。
修正会影响到 grep(1) 的拼写。
警告信息修正(频繁的打印无用的警告是不好的。)
@@ -239,10 +240,12 @@ Linus 和 linux-kernel 邮件列表的 e-mail 流量都很高,一个通常的
建议在发送出去的补丁上加一个 “sign-off” 的过程。
"sign-off" 是在补丁的注释的最后的简单的一行文字,认证你编写了它或者其他
-人有权力将它作为开放源代码的补丁传递。规则很简单:如果你能认证如下信息
-:
- 开发者来源证书 1.1
- 对于本项目的贡献,我认证如下信息:
+人有权力将它作为开放源代码的补丁传递。规则很简单:如果你能认证如下信息:
+
+开发者来源证书 1.1
+^^^^^^^^^^^^^^^^^^
+对于本项目的贡献,我认证如下信息:
+
(a)这些贡献是完全或者部分的由我创建,我有权利以文件中指出
的开放源代码许可证提交它;或者
(b)这些贡献基于以前的工作,据我所知,这些以前的工作受恰当的开放
@@ -338,7 +341,7 @@ Nuff 说过,如果你的代码和这个偏离太多,那么它有可能会被
在头文件里,有条件地定义 "static inline" 函数,或者宏,在代码里用这些东
西。让编译器把那些"空操作"优化掉。
-一个简单的例子,不好的代码:
+一个简单的例子,不好的代码::
dev = alloc_etherdev (sizeof(struct funky_private));
if (!dev)
@@ -349,12 +352,14 @@ Nuff 说过,如果你的代码和这个偏离太多,那么它有可能会被
清理后的例子:
-(头文件里)
+(头文件里)::
+
#ifndef CONFIG_NET_FUNKINESS
static inline void init_funky_net (struct net_device *d) {}
#endif
-(代码文件里)
+(代码文件里)::
+
dev = alloc_etherdev (sizeof(struct funky_private));
if (!dev)
return -ENODEV;
@@ -399,4 +404,3 @@ Kernel Documentation/process/coding-style.rst:
Linus Torvalds's mail on the canonical patch format:
<http://lkml.org/lkml/2005/4/7/183>
---
--
2.19.1.856.g8858448bb
next prev parent reply other threads:[~2019-03-12 3:03 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-12 3:00 [PATCH v4 00/31] clean up and reorg Chinese kernel docs Alex Shi
2019-03-12 3:00 ` [PATCH v4 01/31] docs/zh_CN: add disclaimer file Alex Shi
2019-03-12 3:01 ` [PATCH v4 02/31] docs/zh_CN: move process related docs into process dir Alex Shi
2019-03-12 3:01 ` [PATCH v4 03/31] docs/zh_CN: change Chinese index to know " Alex Shi
2019-03-12 3:01 ` [PATCH v4 04/31] docs/zh_CN: add index file into " Alex Shi
2019-03-12 3:01 ` [PATCH v4 05/31] docs/zh_CN: rename HOWTO into process directory Alex Shi
2019-03-12 3:01 ` [PATCH v4 06/31] docs/zh_CN: howto format changes Alex Shi
2019-03-12 3:01 ` [PATCH v4 07/31] docs/zh_CN: rename SubmittingPatches for html links Alex Shi
2019-03-12 3:01 ` [PATCH v4 08/31] docs/zh_CN: format the submitting-patches doc to rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 09/31] docs/zh_CN: rename stable_kernel_rules doc Alex Shi
2019-03-12 3:01 ` [PATCH v4 10/31] docs/zh_CN: rst format change for stable-kernel-rules Alex Shi
2019-03-12 3:01 ` [PATCH v4 11/31] docs/zh_CN: rename email-clients.txt as email-clients.rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 12/31] docs/zh_CN: do rst format for email-clients.rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 13/31] docs/zh_CN: rename volatile-consider-harmful doc Alex Shi
2019-03-12 3:01 ` [PATCH v4 14/31] docs/zh_CN: volatile doc format changes Alex Shi
2019-03-12 3:01 ` [PATCH v4 15/31] docs/zh_CN: rename SubmittingDrivers Alex Shi
2019-03-12 3:01 ` [PATCH v4 16/31] docs/zh_CN: format submitting drivers as rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 17/31] docs/zh_CN: rename magic-numbers as rst doc Alex Shi
2019-03-12 3:01 ` [PATCH v4 18/31] docs/zh_CN: format the magic-number doc as rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 19/31] docs/zh_CN: rename stable_api_nonsense.txt as stable-api-nonsense.rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 20/31] docs/zh_CN: format stable-api-nonsense Alex Shi
2019-03-12 3:01 ` [PATCH v4 21/31] docs/zh_CN: update Li Yang's email address Alex Shi
2019-03-12 3:01 ` [PATCH v4 22/31] mailmap: " Alex Shi
2019-03-12 3:01 ` [PATCH v4 23/31] docs/zh_CN: update Zhang Wei's " Alex Shi
2019-03-12 3:01 ` [PATCH v4 24/31] mailmap: update email address for Triplex Alex Shi
2019-03-12 3:01 ` [PATCH v4 25/31] docs/zh_CN: update TripleX chung's email address Alex Shi
2019-03-12 3:01 ` [PATCH v4 26/31] docs/zh_CN: fix rst format errors in howto.rst Alex Shi
2019-03-12 3:01 ` [PATCH v4 27/31] docs/zh_CN: fix indent issue in stable-api-nonsense file Alex Shi
2019-03-12 3:01 ` [PATCH v4 28/31] docs/zh_CN: fix indent issue in submitting-drivers Alex Shi
2019-03-12 3:01 ` Alex Shi [this message]
2019-03-12 3:01 ` [PATCH v4 30/31] docs/zh_CN: remove zh-kernel.org in MAINTAINERS Alex Shi
2019-03-12 3:01 ` [PATCH v4 31/31] mailmap: update my obsolete email address Alex Shi
2019-03-12 3:06 ` [PATCH v4 00/31] clean up and reorg Chinese kernel docs Alex Shi
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=20190312030129.47511-30-alex.shi@linux.alibaba.com \
--to=alex.shi@linux.alibaba.com \
--cc=corbet@lwn.net \
--cc=harryxiyou@gmail.com \
--cc=leoyang.li@nxp.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=xxx.phy@gmail.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