AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2024-11-30 09:56:40 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/zh_CN: fix rst format issue in submitting-patch

Browse Source 
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>
Signed-off-by: Weiwei Jia <harryxiyou@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Alex Shi 2019-03-13 21:50:00 +08:00 committed by Jonathan Corbet
parent 9b628c6ab4
commit a31ffdb3fc
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/translations/zh_CN/process/submitting-patches.rst
View File

@ -39,7 +39,7 @@ Documentation/process/submitting-drivers.rst 。
参数生成。而且，请使用 '-p' 参数，那样会显示每个改动所在的C函数，使得 参数生成。而且，请使用 '-p' 参数，那样会显示每个改动所在的C函数，使得
产生的补丁容易读得多。补丁应该基于内核源代码树的根目录，而不是里边的任 产生的补丁容易读得多。补丁应该基于内核源代码树的根目录，而不是里边的任
何子目录。 何子目录。
为一个单独的文件创建补丁，一般来说这样做就够了： 为一个单独的文件创建补丁，一般来说这样做就够了::
SRCTREE= linux-2.6 SRCTREE= linux-2.6
MYFILE= drivers/net/mydriver.c MYFILE= drivers/net/mydriver.c
@ -51,7 +51,7 @@ Documentation/process/submitting-drivers.rst 。
diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
为多个文件创建补丁，你可以解开一个没有修改过的内核源代码树，然后和你自 为多个文件创建补丁，你可以解开一个没有修改过的内核源代码树，然后和你自
己的代码树之间做 diff 。例如： 己的代码树之间做 diff 。例如::
MYSRC= /devel/linux-2.6 MYSRC= /devel/linux-2.6
@ -141,6 +141,7 @@ MAINTAINERS 文件里的）发送一个手册页（man-pages）补丁，或者
对于小的补丁，你也许会CC到 Adrian Bunk 管理的搜集琐碎补丁的邮件列表 对于小的补丁，你也许会CC到 Adrian Bunk 管理的搜集琐碎补丁的邮件列表
(Trivial Patch Monkey)trivial@kernel.org，那里专门收集琐碎的补丁。下面这样 (Trivial Patch Monkey)trivial@kernel.org，那里专门收集琐碎的补丁。下面这样
的补丁会被看作“琐碎的”补丁： 的补丁会被看作“琐碎的”补丁：
文档的拼写修正。 文档的拼写修正。
修正会影响到 grep(1) 的拼写。 修正会影响到 grep(1) 的拼写。
警告信息修正(频繁的打印无用的警告是不好的。) 警告信息修正(频繁的打印无用的警告是不好的。)
@ -241,8 +242,10 @@ Linus 和 linux-kernel 邮件列表的 e-mail 流量都很高，一个通常的
"sign-off" 是在补丁的注释的最后的简单的一行文字，认证你编写了它或者其他 "sign-off" 是在补丁的注释的最后的简单的一行文字，认证你编写了它或者其他
人有权力将它作为开放源代码的补丁传递。规则很简单：如果你能认证如下信息 人有权力将它作为开放源代码的补丁传递。规则很简单：如果你能认证如下信息
： ：
开发者来源证书 1.1 开发者来源证书 1.1
对于本项目的贡献，我认证如下信息： ^^^^^^^^^^^^^^^^^^
对于本项目的贡献，我认证如下信息：
（a）这些贡献是完全或者部分的由我创建，我有权利以文件中指出 （a）这些贡献是完全或者部分的由我创建，我有权利以文件中指出
的开放源代码许可证提交它；或者 的开放源代码许可证提交它；或者
（b）这些贡献基于以前的工作，据我所知，这些以前的工作受恰当的开放 （b）这些贡献基于以前的工作，据我所知，这些以前的工作受恰当的开放
@ -295,7 +298,7 @@ e-mail 标题中的“一句话概述”扼要的描述 e-mail 中的补丁。
丁。用户将希望通过 google 来搜索"一句话概述"来找到那些讨论这个补丁的文 丁。用户将希望通过 google 来搜索"一句话概述"来找到那些讨论这个补丁的文
章。 章。
一些标题的例子： 一些标题的例子::
Subject: [patch 2/5] ext2: improve scalability of bitmap searching Subject: [patch 2/5] ext2: improve scalability of bitmap searching
Subject: [PATCHv2 001/207] x86: fix eflags tracking Subject: [PATCHv2 001/207] x86: fix eflags tracking
@ -338,7 +341,7 @@ Nuff 说过，如果你的代码和这个偏离太多，那么它有可能会被
在头文件里，有条件地定义 "static inline" 函数，或者宏，在代码里用这些东 在头文件里，有条件地定义 "static inline" 函数，或者宏，在代码里用这些东
西。让编译器把那些"空操作"优化掉。 西。让编译器把那些"空操作"优化掉。
一个简单的例子，不好的代码： 一个简单的例子，不好的代码::
dev = alloc_etherdev (sizeof(struct funky_private)); dev = alloc_etherdev (sizeof(struct funky_private));
if (!dev) if (!dev)
@ -349,12 +352,14 @@ Nuff 说过，如果你的代码和这个偏离太多，那么它有可能会被
清理后的例子: 清理后的例子:
(头文件里) (头文件里)::
#ifndef CONFIG_NET_FUNKINESS #ifndef CONFIG_NET_FUNKINESS
static inline void init_funky_net (struct net_device *d) {} static inline void init_funky_net (struct net_device *d) {}
#endif #endif
(代码文件里) (代码文件里)::
dev = alloc_etherdev (sizeof(struct funky_private)); dev = alloc_etherdev (sizeof(struct funky_private));
if (!dev) if (!dev)
return -ENODEV; return -ENODEV;
@ -399,4 +404,3 @@ Kernel Documentation/process/coding-style.rst:
Linus Torvalds's mail on the canonical patch format: Linus Torvalds's mail on the canonical patch format:
<http://lkml.org/lkml/2005/4/7/183> <http://lkml.org/lkml/2005/4/7/183>
--