xref: /linux/Documentation/translations/zh_CN/index.rst (revision be239684b18e1cdcafcf8c7face4a2f562c745ad)
1.. SPDX-License-Identifier: GPL-2.0
2
3.. raw:: latex
4
5	\renewcommand\thesection*
6	\renewcommand\thesubsection*
7	\kerneldocCJKon
8	\kerneldocBeginSC{
9
10.. _linux_doc_zh:
11
12中文翻译
13========
14
15
16.. note::
17
18   **翻译计划:**
19   内核中文文档欢迎任何翻译投稿,特别是关于内核用户和管理员指南部分。
20
21这是中文内核文档树的顶级目录。内核文档,就像内核本身一样,在很大程度上是一
22项正在进行的工作;当我们努力将许多分散的文件整合成一个连贯的整体时尤其如此。
23另外,随时欢迎您对内核文档进行改进;如果您想提供帮助,请加入vger.kernel.org
24上的linux-doc邮件列表。
25
26顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
27的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
28中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。在将
29补丁提交到社区之前,一定要进行必要的 ``checkpatch.pl`` 检查和编译测试。
30
31与Linux 内核社区一起工作
32------------------------
33
34与内核开发社区进行协作并将工作推向上游的基本指南。
35
36.. toctree::
37   :maxdepth: 1
38
39   process/development-process
40   process/submitting-patches
41   行为准则 <process/code-of-conduct>
42   maintainer/index
43   完整开发流程文档 <process/index>
44
45内部API文档
46-----------
47
48开发人员使用的内核内部交互接口手册。
49
50.. toctree::
51   :maxdepth: 1
52
53   core-api/index
54   driver-api/index
55   subsystem-apis
56   内核中的锁 <locking/index>
57
58开发工具和流程
59--------------
60
61为所有内核开发人员提供有用信息的各种其他手册。
62
63.. toctree::
64   :maxdepth: 1
65
66   process/license-rules
67   doc-guide/index
68   dev-tools/index
69   dev-tools/testing-overview
70   kernel-hacking/index
71   rust/index
72
73TODOList:
74
75* trace/index
76* fault-injection/index
77* livepatch/index
78
79面向用户的文档
80--------------
81
82下列手册针对
83希望内核在给定系统上以最佳方式工作的*用户*,
84和查找内核用户空间API信息的程序开发人员。
85
86.. toctree::
87   :maxdepth: 1
88
89   admin-guide/index
90   admin-guide/reporting-issues.rst
91   userspace-api/index
92
93TODOList:
94
95* 内核构建系统 <kbuild/index>
96* 用户空间工具 <tools/index>
97
98也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。
99
100固件相关文档
101------------
102
103下列文档描述了内核需要的平台固件相关信息。
104
105.. toctree::
106   :maxdepth: 2
107
108   devicetree/index
109
110TODOList:
111
112* firmware-guide/index
113
114体系结构文档
115------------
116
117.. toctree::
118   :maxdepth: 2
119
120   arch/index
121
122其他文档
123--------
124
125有几份未分类的文档似乎不适合放在文档的其他部分,或者可能需要进行一些调整和/或
126转换为reStructureText格式,也有可能太旧。
127
128.. toctree::
129   :maxdepth: 2
130
131   staging/index
132
133术语表
134------
135
136.. toctree::
137   :maxdepth: 1
138
139   glossary
140
141
142索引和表格
143----------
144
145* :ref:`genindex`
146
147.. raw:: latex
148
149	}\kerneldocEndSC
150