All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alex Shi <alex.shi@linux.alibaba.com>
To: alex.shi@linux.alibaba.com, harryxiyou@gmail.com, corbet@lwn.net,
	leoyang.li@nxp.com, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Subject: [PATCH 24/42] docs/zh_CN: add submit-checklist file
Date: Wed, 27 Mar 2019 21:01:30 +0800	[thread overview]
Message-ID: <20190327130148.3258-25-alex.shi@linux.alibaba.com> (raw)
In-Reply-To: <20190327130148.3258-1-alex.shi@linux.alibaba.com>

Now it appears in 'make htmldocs' in Chinese version.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
---
 .../zh_CN/process/submit-checklist.rst        | 102 ++++++++++++++++++
 1 file changed, 102 insertions(+)
 create mode 100644 Documentation/translations/zh_CN/process/submit-checklist.rst

diff --git a/Documentation/translations/zh_CN/process/submit-checklist.rst b/Documentation/translations/zh_CN/process/submit-checklist.rst
new file mode 100644
index 000000000000..012f2bf88a35
--- /dev/null
+++ b/Documentation/translations/zh_CN/process/submit-checklist.rst
@@ -0,0 +1,102 @@
+.. _cn_submitchecklist:
+
+Linux内核补丁提交清单
+~~~~~~~~~~~~~~~~~~~~~
+
+如果开发人员希望看到他们的内核补丁提交更快地被接受,那么他们应该做一些基本
+的事情。
+
+这些都是在
+:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
+和其他有关提交Linux内核补丁的文档中提供的。
+
+1) 如果使用工具,则包括定义/声明该工具的文件。不要依赖于其他头文件拉入您使用
+   的头文件。
+
+2) 干净的编译:
+
+   a) 使用适用或修改的 ``CONFIG`` 选项 ``=y``、``=m`` 和 ``=n`` 。没有GCC
+      警告/错误,没有链接器警告/错误。
+
+   b) 通过allnoconfig、allmodconfig
+
+   c) 使用 ``O=builddir`` 时可以成功编译
+
+3) 通过使用本地交叉编译工具或其他一些构建场在多个CPU体系结构上构建。
+
+4) PPC64是一种很好的交叉编译检查体系结构,因为它倾向于对64位的数使用无符号
+   长整型。
+
+5) 如下所述 :ref:`Documentation/process/coding-style.rst <codingstyle>`.
+   检查您的补丁是否为常规样式。在提交( ``scripts/check patch.pl`` )之前,
+   使用补丁样式检查器检查是否有轻微的冲突。您应该能够处理您的补丁中存在的所有
+   违规行为。
+
+6) 任何新的或修改过的 ``CONFIG`` 选项都不会弄脏配置菜单,并默认为关闭,除非
+   它们符合 ``Documentation/kbuild/kconfig-language.txt`` 中记录的异常条件,
+   菜单属性:默认值.
+
+7) 所有新的 ``kconfig`` 选项都有帮助文本。
+
+8) 已仔细审查了相关的 ``Kconfig`` 组合。这很难用测试来纠正——脑力在这里是有
+   回报的。
+
+9) 用 sparse 检查干净。
+
+10) 使用 ``make checkstack`` 和 ``make namespacecheck`` 并修复他们发现的任何
+    问题。
+
+    .. note::
+
+        ``checkstack`` 并没有明确指出问题,但是任何一个在堆栈上使用超过512
+        字节的函数都可以进行更改。
+
+11) 包括 :ref:`kernel-doc <kernel_doc>` 内核文档以记录全局内核API。(静态函数
+    不需要,但也可以。)使用 ``make htmldocs`` 或 ``make pdfdocs`` 检查
+    :ref:`kernel-doc <kernel_doc>` 并修复任何问题。
+
+12) 通过以下选项同时启用的测试 ``CONFIG_PREEMPT``, ``CONFIG_DEBUG_PREEMPT``,
+    ``CONFIG_DEBUG_SLAB``, ``CONFIG_DEBUG_PAGEALLOC``, ``CONFIG_DEBUG_MUTEXES``,
+    ``CONFIG_DEBUG_SPINLOCK``, ``CONFIG_DEBUG_ATOMIC_SLEEP``,
+    ``CONFIG_PROVE_RCU`` and ``CONFIG_DEBUG_OBJECTS_RCU_HEAD``
+
+13) 已经过构建和运行时测试,包括有或没有 ``CONFIG_SMP``, ``CONFIG_PREEMPT``.
+
+14) 如果补丁程序影响IO/磁盘等:使用或不使用 ``CONFIG_LBDAF`` 进行测试。
+
+15) 所有代码路径都已在启用所有lockdep功能的情况下运行。
+
+16) 所有新的/proc条目都记录在 ``Documentation/``
+
+17) 所有新的内核引导参数都记录在
+    Documentation/admin-guide/kernel-parameters.rst 中。
+
+18) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
+
+19) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息,
+    请参阅 ``Documentation/ABI/README`` 。更改用户空间接口的补丁应该抄送
+    linux-api@vger.kernel.org。
+
+20) 检查是否全部通过 ``make headers_check`` 。
+
+21) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/``
+    如果新代码是实质性的,那么添加子系统特定的故障注入可能是合适的。
+
+22) 新添加的代码已经用 ``gcc -W`` 编译(使用 ``make EXTRA-CFLAGS=-W`` )。这
+    将产生大量噪声,但对于查找诸如“警告:有符号和无符号之间的比较”之类的错误
+    很有用。
+
+23) 在它被合并到-mm补丁集中之后进行测试,以确保它仍然与所有其他排队的补丁以
+    及VM、VFS和其他子系统中的各种更改一起工作。
+
+24) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注
+    释来解释它们正在执行的操作及其原因的逻辑。
+
+25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/ioctl/ioctl-number.txt``
+
+26) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或
+    功能,则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` (如果该选项可用)的情况
+    下测试以下多个构建[并非所有这些都同时存在,只是它们的各种/随机组合]:
+
+    ``CONFIG_SMP``, ``CONFIG_SYSFS``, ``CONFIG_PROC_FS``, ``CONFIG_INPUT``, ``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``,
+    ``CONFIG_NET``, ``CONFIG_INET=n`` (但是后者伴随 ``CONFIG_NET=y``).
-- 
2.19.1.856.g8858448bb


  parent reply	other threads:[~2019-03-27 13:03 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-27 13:01 [PATCH 00/42] Chinese doc translation series 2 Alex Shi
2019-03-27 13:01 ` [PATCH 01/42] docs/zh_CN: translate development-process into Chinese Alex Shi
2019-03-27 13:01 ` [PATCH 02/42] docs/zh_CN: add disclaimer and translator info in development-process Alex Shi
2019-03-27 13:01 ` [PATCH 03/42] docs/zh_CN: link development-process into process index Alex Shi
2019-03-27 13:01 ` [PATCH 04/42] docs/zh_CN: add Chinese 1.Intro file Alex Shi
2019-03-27 13:01 ` [PATCH 05/42] docs/zh_CN: add disclaimer and translator info into 1.Intro Alex Shi
2019-03-27 13:01 ` [PATCH 06/42] docs/zh_CN: add 2.Process.rst for development-process Alex Shi
2019-03-27 13:01 ` [PATCH 07/42] docs/zh_CN: add disclaimer and translator info in 2.Process Alex Shi
2019-03-27 13:01 ` [PATCH 08/42] docs/zh_CN: translate 3.Early-stage of development process Alex Shi
2019-03-27 13:01 ` [PATCH 09/42] docs/zh_CN: add disclaimer/translator info in 3.Early-stage Alex Shi
2019-03-27 13:01 ` [PATCH 10/42] docs/zh_CN: add 4.Coding.rst Alex Shi
2019-03-27 13:01 ` [PATCH 11/42] docs/zh_CN: add disclaimer and translator info in 4.Coding Alex Shi
2019-03-27 13:01 ` [PATCH 12/42] docs/zh_CN: add 5.Posting.rst into development-process Alex Shi
2019-03-27 13:01 ` [PATCH 13/42] docs/zh_CN: add disclaimer and translator info in 5.Posting Alex Shi
2019-03-27 13:01 ` [PATCH 14/42] docs/zh_CN: add the 6th doc 6.Followthrought.rst Alex Shi
2019-03-27 13:01 ` [PATCH 15/42] docs/zh_CN: add disclaimer and translator info in 6.Followthrough Alex Shi
2019-03-27 13:01 ` [PATCH 16/42] docs/zh_CN: translate 7.AdvanceTopics.rst Alex Shi
2019-03-27 13:01 ` [PATCH 17/42] docs/zh_CN: add disclaimer and translator info in 7.Advancedtopics Alex Shi
2019-03-27 13:01 ` [PATCH 18/42] docs/zh_CN: add 8.Conclusion.rst in development-process Alex Shi
2019-03-27 13:01 ` [PATCH 19/42] docs/zh_CN: add disclaimer and translator info in 8.Conclusion Alex Shi
2019-03-27 13:01 ` [PATCH 20/42] docs/zh_CN: add license-rules Chinese translation Alex Shi
2019-03-27 13:01 ` [PATCH 21/42] docs/zh_CN: fix links failure in license-rules Alex Shi
2019-03-27 13:01 ` [PATCH 22/42] docs/zh_CN: include Chinese translation header for license-rules Alex Shi
2019-03-27 13:01 ` [PATCH 23/42] docs/zh_CN: link the license-rules file into process index Alex Shi
2019-03-27 13:01 ` Alex Shi [this message]
2019-03-27 13:01 ` [PATCH 25/42] docs/zh_CN: add disclaimer and transtlator info in submit-checklist Alex Shi
2019-03-27 13:01 ` [PATCH 26/42] docs/zh_CN: link the submit-checklist into process/index Alex Shi
2019-03-27 13:01 ` [PATCH 27/42] docs/zh_CN: add CoC doc Alex Shi
2019-03-27 13:01 ` [PATCH 28/42] docs/zh_CN: add disclaimer and translator info in CoC Alex Shi
2019-03-27 13:01 ` [PATCH 29/42] docs/zh_CN: link the CoC into process/index Alex Shi
2019-03-27 13:01 ` [PATCH 30/42] docs/zh_CN: add CoC interpretation Alex Shi
2019-03-27 13:01 ` [PATCH 31/42] docs/zh_CN: add disclaim and translator into CoC interp Alex Shi
2019-03-27 13:01 ` [PATCH 32/42] docs/zh_CN: link CoC interpretation into index Alex Shi
2019-03-27 13:01 ` [PATCH 33/42] docs/zh_CN: fix link issue in howto.rst Alex Shi
2019-03-27 13:01 ` [PATCH 34/42] docs/zh_CN: update howto.rst to latest version Alex Shi
2019-03-27 13:01 ` [PATCH 35/42] docs/zh_CN: update translator info and comments in howto Alex Shi
2019-03-27 13:01 ` [PATCH 36/42] docs/zh_CN: redirect license-rules to Chinese doc Alex Shi
2019-03-27 13:01 ` [PATCH 37/42] docs/zh_CN: redirect howto.rst link to Chinese version Alex Shi
2019-03-27 13:01 ` [PATCH 38/42] docs/zh_CN: update to latest submitting-patches.rst Alex Shi
2019-03-27 13:01 ` [PATCH 39/42] docs/zh_CN: update translator info in submitting-patches Alex Shi
2019-03-27 13:01 ` [PATCH 40/42] docs/zh_CN: redirect the submitting-patches to Chinese doc Alex Shi
2019-03-27 13:01 ` [PATCH 41/42] docs/zh_CN: redirect submit-checklist Alex Shi
2019-03-27 13:01 ` [PATCH 42/42] docs/zh_CN: update co-developed-by info after English version 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=20190327130148.3258-25-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 \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.