Skip to content

Commit

Permalink
docs/zh_CN: Adjust order and content of zh_CN/index.rst
Browse files Browse the repository at this point in the history
Adjust order and content of zh_CN/index.rst to make it clear,
complete introductions and TODOLists.

Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/20210430122234.GA655@bobwxc.top
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Wu XiangCheng authored and Jonathan Corbet committed May 3, 2021
1 parent eef8abd commit bd8ede4
Showing 1 changed file with 158 additions and 10 deletions.
168 changes: 158 additions & 10 deletions Documentation/translations/zh_CN/index.rst
Original file line number Diff line number Diff line change
@@ -1,36 +1,184 @@
.. SPDX-License-Identifier: GPL-2.0
.. raw:: latex

\renewcommand\thesection*
\renewcommand\thesubsection*

.. _linux_doc_zh:

中文翻译
========

这些手册包含有关如何开发内核的整体信息。内核社区非常庞大,一年下来有数千名开发
人员做出贡献。 与任何大型社区一样,知道如何完成任务将使得更改合并的过程变得更
加容易。

翻译计划:
内核中文文档欢迎任何翻译投稿,特别是关于内核用户和管理员指南部分。
.. note::

**翻译计划:**
内核中文文档欢迎任何翻译投稿,特别是关于内核用户和管理员指南部分。

许可证文档
----------

下面的文档介绍了Linux内核源代码的许可证(GPLv2)、如何在源代码树中正确标记
单个文件的许可证、以及指向完整许可证文本的链接。

* Documentation/translations/zh_CN/process/license-rules.rst

用户文档
--------

下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
用户。

.. toctree::
:maxdepth: 2

admin-guide/index

TODOList:

* kbuild/index

固件相关文档
------------

下列文档描述了内核需要的平台固件相关信息。

TODOList:

* firmware-guide/index
* devicetree/index

应用程序开发人员文档
--------------------

用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。

TODOlist:

* userspace-api/index

内核开发简介
------------

这些手册包含有关如何开发内核的整体信息。内核社区非常庞大,一年下来有数千名
开发人员做出贡献。与任何大型社区一样,知道如何完成任务将使得更改合并的过程
变得更加容易。

.. toctree::
:maxdepth: 2

process/index
dev-tools/index
doc-guide/index
kernel-hacking/index
filesystems/index
arm64/index
sound/index

TODOList:

* trace/index
* maintainer/index
* fault-injection/index
* livepatch/index
* rust/index

内核API文档
-----------

以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的
大部分信息都是直接从内核源代码获取的,并根据需要添加补充材料(或者至少是在
我们设法添加的时候——可能不是所有的都是有需要的)。

.. toctree::
:maxdepth: 2

core-api/index
cpu-freq/index
mips/index
iio/index
sound/index
filesystems/index

TODOList:

* driver-api/index
* locking/index
* accounting/index
* block/index
* cdrom/index
* ide/index
* fb/index
* fpga/index
* hid/index
* i2c/index
* isdn/index
* infiniband/index
* leds/index
* netlabel/index
* networking/index
* pcmcia/index
* power/index
* target/index
* timers/index
* spi/index
* w1/index
* watchdog/index
* virt/index
* input/index
* hwmon/index
* gpu/index
* security/index
* crypto/index
* vm/index
* bpf/index
* usb/index
* PCI/index
* scsi/index
* misc-devices/index
* scheduler/index
* mhi/index

体系结构无关文档
----------------

TODOList:

* asm-annotations

特定体系结构文档
----------------

.. toctree::
:maxdepth: 2

mips/index
arm64/index
riscv/index
core-api/index
openrisc/index

TODOList:

* arm/index
* ia64/index
* m68k/index
* nios2/index
* parisc/index
* powerpc/index
* s390/index
* sh/index
* sparc/index
* x86/index
* xtensa/index

其他文档
--------

有几份未排序的文档似乎不适合放在文档的其他部分,或者可能需要进行一些调整和/或
转换为reStructureText格式,也有可能太旧。

TODOList:

* staging/index
* watch_queue

目录和表格
----------

Expand Down

0 comments on commit bd8ede4

Please sign in to comment.