Skip to contentSkip to conversation

docs/zh_CN: Rewrite the zh_CN/index.rst

PATCH In review Wu XiangCheng 4 participants 11 messages Oct 11, 2022 – Oct 13, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v2 cover docs/zh_CN: Rewrite the zh_CN/index.rst

Follow Jonathan's steps[1], rewrite the entry point of kernel's Chinese translation documentation.

[1]: https://lore.kernel.org/linux-doc/[email protected]/T

v2:
* remove blank line
* fix typo
v1:

	https://lore.kernel.org/linux-doc/[email protected]/T/#t

Thanks,

Wu XiangCheng (4):
docs/zh_CN: promote the title of zh_CN/process/index.rst docs/zh_CN: add zh_CN/arch.rst
docs/zh_CN: Rewrite the Chinese translation front page docs/zh_CN: add a man-pages link to zh_CN/index.rst

 Documentation/translations/zh_CN/arch.rst     |  29 +++
 Documentation/translations/zh_CN/index.rst    | 169 ++++++------------
 .../translations/zh_CN/process/index.rst      |   1 +
 3 files changed, 82 insertions(+), 117 deletions(-)
 create mode 100644 Documentation/translations/zh_CN/arch.rst

base-commit: df39f6bb3c59784acf0c31f2c5e7eee3a4fea354

Signature · 5 lines
2.30.2


-- 
Wu XiangCheng	0x32684A40BCA7AEA7
#1 lore raw

PATCH v2 1/4 docs/zh_CN: promote the title of zh_CN/process/index.rst

From: Wu XiangCheng <[email protected]>

update to commit 9d0f5cd16744 ("docs: promote the title of process/index.rst")

---
 Documentation/translations/zh_CN/process/index.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/translations/zh_CN/process/index.rst +1 -0
index a683dbea0c83..a1a35f88f4ae 100644
@@ -10,6 +10,7 @@
 
 .. _cn_process_index:
 
+========================
 与Linux 内核社区一起工作
 ========================
 
Signature · 5 lines
2.30.2


-- 
Wu XiangCheng	0x32684A40BCA7AEA7
Reviewed-by on v2 1/4
#2 lore raw

Re: [PATCH v2 1/4] docs/zh_CN: promote the title of zh_CN/process/index.rst

Quoted 6 lines · Wu XiangCheng

From: Wu XiangCheng <[email protected]>

update to commit 9d0f5cd16744 ("docs: promote the title of process/index.rst")

Quoted 16 lines
---
  Documentation/translations/zh_CN/process/index.rst | 1 +
  1 file changed, 1 insertion(+)
Documentation/translations/zh_CN/process/index.rst +1 -0
index a683dbea0c83..a1a35f88f4ae 100644
@@ -10,6 +10,7 @@
 
  .. _cn_process_index:
 
+========================
  与Linux 内核社区一起工作
  ========================
 
#3 lore raw

PATCH v2 2/4 docs/zh_CN: add zh_CN/arch.rst

In reply to Wu XiangCheng

From: Wu XiangCheng <[email protected]>

Add an entry for all zh arch documents.

---
 Documentation/translations/zh_CN/arch.rst | 29 +++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 Documentation/translations/zh_CN/arch.rst
Documentation/translations/zh_CN/arch.rst new file +29 -0
new file mode 100644
index 000000000000..690e173d8b2a
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+处理器体系结构
+==============
+
+以下文档提供了具体架构实现的编程细节。
+
+.. toctree::
+   :maxdepth: 2
+
+   mips/index
+   arm64/index
+   riscv/index
+   openrisc/index
+   parisc/index
+   loongarch/index
+
+TODOList:
+
+* arm/index
+* ia64/index
+* m68k/index
+* nios2/index
+* powerpc/index
+* s390/index
+* sh/index
+* sparc/index
+* x86/index
+* xtensa/index
Signature · 5 lines
2.30.2


-- 
Wu XiangCheng	0x32684A40BCA7AEA7
Reviewed-by on v2 2/4
#4 lore raw

Re: [PATCH v2 2/4] docs/zh_CN: add zh_CN/arch.rst

Quoted 5 lines · Wu XiangCheng

From: Wu XiangCheng <[email protected]>

Add an entry for all zh arch documents.

Quoted 40 lines
---
  Documentation/translations/zh_CN/arch.rst | 29 +++++++++++++++++++++++
  1 file changed, 29 insertions(+)

create mode 100644 Documentation/translations/zh_CN/arch.rst

Documentation/translations/zh_CN/arch.rst new file +29 -0
new file mode 100644
index 000000000000..690e173d8b2a
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+处理器体系结构
+==============
+
+以下文档提供了具体架构实现的编程细节。
+
+.. toctree::
+   :maxdepth: 2
+
+   mips/index
+   arm64/index
+   riscv/index
+   openrisc/index
+   parisc/index
+   loongarch/index
+
+TODOList:
+
+* arm/index
+* ia64/index
+* m68k/index
+* nios2/index
+* powerpc/index
+* s390/index
+* sh/index
+* sparc/index
+* x86/index
+* xtensa/index
Reviewed-by
#5 lore raw

Re: [PATCH v2 2/4] docs/zh_CN: add zh_CN/arch.rst

Quoted 50 lines · Yanteng Si
Quoted 5 lines · Wu XiangCheng

From: Wu XiangCheng <[email protected]>

Add an entry for all zh arch documents.

Quoted 40 lines
---
  Documentation/translations/zh_CN/arch.rst | 29 +++++++++++++++++++++++
  1 file changed, 29 insertions(+)

create mode 100644 Documentation/translations/zh_CN/arch.rst

Documentation/translations/zh_CN/arch.rst new file +29 -0
new file mode 100644
index 000000000000..690e173d8b2a
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+处理器体系结构
+==============
+
+以下文档提供了具体架构实现的编程细节。
+
+.. toctree::
+   :maxdepth: 2
+
+   mips/index
+   arm64/index
+   riscv/index
+   openrisc/index
+   parisc/index
+   loongarch/index
+
+TODOList:
+
+* arm/index
+* ia64/index
+* m68k/index
+* nios2/index
+* powerpc/index
+* s390/index
+* sh/index
+* sparc/index
+* x86/index
+* xtensa/index
#6 lore raw

PATCH v2 3/4 docs/zh_CN: Rewrite the Chinese translation front page

In reply to Wu XiangCheng

From: Wu XiangCheng <[email protected]>

update to commit 0c7b4366f1ab ("docs: Rewrite the front page")

---
 Documentation/translations/zh_CN/index.rst | 169 +++++++--------------
 1 file changed, 51 insertions(+), 118 deletions(-)
Documentation/translations/zh_CN/index.rst +51 -118
index 2fc60e60feb4..7be728bed46d 100644
@@ -26,165 +26,98 @@
 顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
 的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
 中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。在将
-补丁提交到社区之前,一定要进行必要的checkpatch.pl检查和编译测试。
+补丁提交到社区之前,一定要进行必要的 ``checkpatch.pl`` 检查和编译测试。
 
-许可证文档
-----------
-
-下面的文档介绍了Linux内核源代码的许可证(GPLv2)、如何在源代码树中正确标记
-单个文件的许可证、以及指向完整许可证文本的链接。
+与Linux 内核社区一起工作
+------------------------
 
-* Documentation/translations/zh_CN/process/license-rules.rst
-
-用户文档
---------
-
-下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
-用户。
+与内核开发社区进行协作并将工作推向上游的基本指南。
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   admin-guide/index
-
-TODOList:
-
-* kbuild/index
+   process/development-process
+   process/submitting-patches
+   行为准则 <process/code-of-conduct>
+   maintainer/index
+   完整开发流程文档 <process/index>
 
-固件相关文档
-------------
+内部API文档
+-----------
 
-下列文档描述了内核需要的平台固件相关信息。
+开发人员使用的内核内部交互接口手册。
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   devicetree/index
+   core-api/index
+   driver-api/index
+   内核中的锁 <locking/index>
 
 TODOList:
 
-* firmware-guide/index
-
-应用程序开发人员文档
---------------------
-
-用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。
-
-TODOlist:
-
-* userspace-api/index
+* subsystem-apis
 
-内核开发简介
-------------
+开发工具和流程
+--------------
 
-这些手册包含有关如何开发内核的整体信息。内核社区非常庞大,一年下来有数千名
-开发人员做出贡献。与任何大型社区一样,知道如何完成任务将使得更改合并的过程
-变得更加容易。
+为所有内核开发人员提供有用信息的各种其他手册。
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   process/index
-   dev-tools/index
+   process/license-rules
    doc-guide/index
+   dev-tools/index
+   dev-tools/testing-overview
    kernel-hacking/index
-   maintainer/index
 
 TODOList:
 
 * trace/index
 * fault-injection/index
 * livepatch/index
-* rust/index
 
-内核API文档
------------
+面向用户的文档
+--------------
 
-以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的
-大部分信息都是直接从内核源代码获取的,并根据需要添加补充材料(或者至少是在
-我们设法添加的时候——可能不是所有的都是有需要的)。
+下列手册针对
+希望内核在给定系统上以最佳方式工作的*用户*,
+和查找内核用户空间API信息的程序开发人员。
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   core-api/index
-   driver-api/index
-   locking/index
-   accounting/index
-   cpu-freq/index
-   iio/index
-   infiniband/index
-   power/index
-   virt/index
-   sound/index
-   filesystems/index
-   scheduler/index
-   mm/index
-   peci/index
-   PCI/index
+   admin-guide/index
+   admin-guide/reporting-issues.rst
 
 TODOList:
 
-* block/index
-* cdrom/index
-* ide/index
-* fb/index
-* fpga/index
-* hid/index
-* i2c/index
-* isdn/index
-* leds/index
-* netlabel/index
-* networking/index
-* pcmcia/index
-* target/index
-* timers/index
-* spi/index
-* w1/index
-* watchdog/index
-* input/index
-* hwmon/index
-* gpu/index
-* security/index
-* crypto/index
-* bpf/index
-* usb/index
-* scsi/index
-* misc-devices/index
-* mhi/index
-
-体系结构无关文档
-----------------
-
-TODOList:
+* 内核构建系统 <kbuild/index>
+* 用户空间工具 <tools/index>
+* userspace-api/index
 
-* asm-annotations
+固件相关文档
+------------
 
-特定体系结构文档
-----------------
+下列文档描述了内核需要的平台固件相关信息。
 
 .. toctree::
    :maxdepth: 2
 
-   mips/index
-   arm64/index
-   riscv/index
-   openrisc/index
-   parisc/index
-   loongarch/index
+   devicetree/index
 
 TODOList:
 
-* arm/index
-* ia64/index
-* m68k/index
-* nios2/index
-* powerpc/index
-* s390/index
-* sh/index
-* sparc/index
-* x86/index
-* xtensa/index
+* firmware-guide/index
+
+体系结构文档
+------------
+
+.. toctree::
+   :maxdepth: 2
+
+   arch
 
 其他文档
 --------
@@ -195,9 +128,9 @@ TODOList:
 TODOList:
 
 * staging/index
-* watch_queue
 
-目录和表格
+
+索引和表格
 ----------
 
 * :ref:`genindex`
Signature · 5 lines
2.30.2


-- 
Wu XiangCheng	0x32684A40BCA7AEA7
Reviewed-by on v2 3/4
#7 lore raw

Re: [PATCH v2 3/4] docs/zh_CN: Rewrite the Chinese translation front page

Quoted 5 lines · Wu XiangCheng

From: Wu XiangCheng <[email protected]>

update to commit 0c7b4366f1ab ("docs: Rewrite the front page")

Quoted 235 lines
---
  Documentation/translations/zh_CN/index.rst | 169 +++++++--------------
  1 file changed, 51 insertions(+), 118 deletions(-)
Documentation/translations/zh_CN/index.rst +51 -118
index 2fc60e60feb4..7be728bed46d 100644
@@ -26,165 +26,98 @@
  顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
  的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
  中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。在将
-补丁提交到社区之前,一定要进行必要的checkpatch.pl检查和编译测试。
+补丁提交到社区之前,一定要进行必要的 ``checkpatch.pl`` 检查和编译测试。
 
-许可证文档
-----------
-
-下面的文档介绍了Linux内核源代码的许可证(GPLv2)、如何在源代码树中正确标记
-单个文件的许可证、以及指向完整许可证文本的链接。
+与Linux 内核社区一起工作
+------------------------
 
-* Documentation/translations/zh_CN/process/license-rules.rst
-
-用户文档
---------
-
-下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
-用户。
+与内核开发社区进行协作并将工作推向上游的基本指南。
 
  .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   admin-guide/index
-
-TODOList:
-
-* kbuild/index
+   process/development-process
+   process/submitting-patches
+   行为准则 <process/code-of-conduct>
+   maintainer/index
+   完整开发流程文档 <process/index>
 
-固件相关文档
-------------
+内部API文档
+-----------
 
-下列文档描述了内核需要的平台固件相关信息。
+开发人员使用的内核内部交互接口手册。
 
  .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   devicetree/index
+   core-api/index
+   driver-api/index
+   内核中的锁 <locking/index>
 
  TODOList:
 
-* firmware-guide/index
-
-应用程序开发人员文档
---------------------
-
-用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。
-
-TODOlist:
-
-* userspace-api/index
+* subsystem-apis
 
-内核开发简介
-------------
+开发工具和流程
+--------------
 
-这些手册包含有关如何开发内核的整体信息。内核社区非常庞大,一年下来有数千名
-开发人员做出贡献。与任何大型社区一样,知道如何完成任务将使得更改合并的过程
-变得更加容易。
+为所有内核开发人员提供有用信息的各种其他手册。
 
  .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   process/index
-   dev-tools/index
+   process/license-rules
     doc-guide/index
+   dev-tools/index
+   dev-tools/testing-overview
     kernel-hacking/index
-   maintainer/index
 
  TODOList:
 
  * trace/index
  * fault-injection/index
  * livepatch/index
-* rust/index
 
-内核API文档
------------
+面向用户的文档
+--------------
 
-以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的
-大部分信息都是直接从内核源代码获取的,并根据需要添加补充材料(或者至少是在
-我们设法添加的时候——可能不是所有的都是有需要的)。
+下列手册针对
+希望内核在给定系统上以最佳方式工作的*用户*,
+和查找内核用户空间API信息的程序开发人员。
 
  .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   core-api/index
-   driver-api/index
-   locking/index
-   accounting/index
-   cpu-freq/index
-   iio/index
-   infiniband/index
-   power/index
-   virt/index
-   sound/index
-   filesystems/index
-   scheduler/index
-   mm/index
-   peci/index
-   PCI/index
+   admin-guide/index
+   admin-guide/reporting-issues.rst
 
  TODOList:
 
-* block/index
-* cdrom/index
-* ide/index
-* fb/index
-* fpga/index
-* hid/index
-* i2c/index
-* isdn/index
-* leds/index
-* netlabel/index
-* networking/index
-* pcmcia/index
-* target/index
-* timers/index
-* spi/index
-* w1/index
-* watchdog/index
-* input/index
-* hwmon/index
-* gpu/index
-* security/index
-* crypto/index
-* bpf/index
-* usb/index
-* scsi/index
-* misc-devices/index
-* mhi/index
-
-体系结构无关文档
-----------------
-
-TODOList:
+* 内核构建系统 <kbuild/index>
+* 用户空间工具 <tools/index>
+* userspace-api/index
 
-* asm-annotations
+固件相关文档
+------------
 
-特定体系结构文档
-----------------
+下列文档描述了内核需要的平台固件相关信息。
 
  .. toctree::
     :maxdepth: 2
 
-   mips/index
-   arm64/index
-   riscv/index
-   openrisc/index
-   parisc/index
-   loongarch/index
+   devicetree/index
 
  TODOList:
 
-* arm/index
-* ia64/index
-* m68k/index
-* nios2/index
-* powerpc/index
-* s390/index
-* sh/index
-* sparc/index
-* x86/index
-* xtensa/index
+* firmware-guide/index
+
+体系结构文档
+------------
+
+.. toctree::
+   :maxdepth: 2
+
+   arch
 
  其他文档
  --------
@@ -195,9 +128,9 @@ TODOList:
  TODOList:
 
  * staging/index
-* watch_queue
 
-目录和表格
+
+索引和表格
  ----------
 
  * :ref:`genindex`
#8 lore raw

PATCH v2 4/4 docs/zh_CN: add a man-pages link to zh_CN/index.rst

In reply to Wu XiangCheng

From: Wu XiangCheng <[email protected]>

update to commit 489876063fb1 ("docs: add a man-pages link to the front page")

---
 Documentation/translations/zh_CN/index.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/translations/zh_CN/index.rst +2 -0
index 7be728bed46d..ec99ef5fe990 100644
@@ -97,6 +97,8 @@ TODOList:
 * 用户空间工具 <tools/index>
 * userspace-api/index
 
+也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。
+
 固件相关文档
 ------------
 
Signature · 5 lines
2.30.2


-- 
Wu XiangCheng	0x32684A40BCA7AEA7
Reviewed-by on v2 4/4
#9 lore raw

Re: [PATCH v2 4/4] docs/zh_CN: add a man-pages link to zh_CN/index.rst

Quoted 6 lines · Wu XiangCheng

From: Wu XiangCheng <[email protected]>

update to commit 489876063fb1 ("docs: add a man-pages link to the front page")

Quoted 17 lines
---
  Documentation/translations/zh_CN/index.rst | 2 ++
  1 file changed, 2 insertions(+)
Documentation/translations/zh_CN/index.rst +2 -0
index 7be728bed46d..ec99ef5fe990 100644
@@ -97,6 +97,8 @@ TODOList:
  * 用户空间工具 <tools/index>
  * userspace-api/index
 
+也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。
+
  固件相关文档
  ------------
 
maintainer
#10 lore raw
In reply to Wu XiangCheng
Quoted 19 lines · Wu XiangCheng

Follow Jonathan's steps[1], rewrite the entry point of kernel's Chinese translation documentation.

[1]: https://lore.kernel.org/linux-doc/[email protected]/T

v2:
* remove blank line
* fix typo
v1:

	https://lore.kernel.org/linux-doc/[email protected]/T/#t

Thanks,

Wu XiangCheng (4):
docs/zh_CN: promote the title of zh_CN/process/index.rst docs/zh_CN: add zh_CN/arch.rst
docs/zh_CN: Rewrite the Chinese translation front page docs/zh_CN: add a man-pages link to zh_CN/index.rst

Quoted 5 lines
 Documentation/translations/zh_CN/arch.rst     |  29 +++
 Documentation/translations/zh_CN/index.rst    | 169 ++++++------------
 .../translations/zh_CN/process/index.rst      |   1 +
 3 files changed, 82 insertions(+), 117 deletions(-)
 create mode 100644 Documentation/translations/zh_CN/arch.rst

Series applied, thanks.

jon