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