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许可证文档
32----------
33
34下面的文档介绍了Linux内核源代码的许可证(GPLv2)、如何在源代码树中正确标记
35单个文件的许可证、以及指向完整许可证文本的链接。
36
37* Documentation/translations/zh_CN/process/license-rules.rst
38
39用户文档
40--------
41
42下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
43用户。
44
45.. toctree::
46   :maxdepth: 2
47
48   admin-guide/index
49
50TODOList:
51
52* kbuild/index
53
54固件相关文档
55------------
56
57下列文档描述了内核需要的平台固件相关信息。
58
59TODOList:
60
61* firmware-guide/index
62* devicetree/index
63
64应用程序开发人员文档
65--------------------
66
67用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。
68
69TODOlist:
70
71* userspace-api/index
72
73内核开发简介
74------------
75
76这些手册包含有关如何开发内核的整体信息。内核社区非常庞大,一年下来有数千名
77开发人员做出贡献。与任何大型社区一样,知道如何完成任务将使得更改合并的过程
78变得更加容易。
79
80.. toctree::
81   :maxdepth: 2
82
83   process/index
84   dev-tools/index
85   doc-guide/index
86   kernel-hacking/index
87   maintainer/index
88
89TODOList:
90
91* trace/index
92* fault-injection/index
93* livepatch/index
94* rust/index
95
96内核API文档
97-----------
98
99以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的
100大部分信息都是直接从内核源代码获取的,并根据需要添加补充材料(或者至少是在
101我们设法添加的时候——可能不是所有的都是有需要的)。
102
103.. toctree::
104   :maxdepth: 2
105
106   core-api/index
107   cpu-freq/index
108   iio/index
109   sound/index
110   filesystems/index
111   virt/index
112   infiniband/index
113   accounting/index
114   scheduler/index
115
116TODOList:
117
118* driver-api/index
119* locking/index
120* block/index
121* cdrom/index
122* ide/index
123* fb/index
124* fpga/index
125* hid/index
126* i2c/index
127* isdn/index
128* leds/index
129* netlabel/index
130* networking/index
131* pcmcia/index
132* power/index
133* target/index
134* timers/index
135* spi/index
136* w1/index
137* watchdog/index
138* input/index
139* hwmon/index
140* gpu/index
141* security/index
142* crypto/index
143* vm/index
144* bpf/index
145* usb/index
146* PCI/index
147* scsi/index
148* misc-devices/index
149* mhi/index
150
151体系结构无关文档
152----------------
153
154TODOList:
155
156* asm-annotations
157
158特定体系结构文档
159----------------
160
161.. toctree::
162   :maxdepth: 2
163
164   mips/index
165   arm64/index
166   riscv/index
167   openrisc/index
168   parisc/index
169
170TODOList:
171
172* arm/index
173* ia64/index
174* m68k/index
175* nios2/index
176* powerpc/index
177* s390/index
178* sh/index
179* sparc/index
180* x86/index
181* xtensa/index
182
183其他文档
184--------
185
186有几份未排序的文档似乎不适合放在文档的其他部分,或者可能需要进行一些调整和/或
187转换为reStructureText格式,也有可能太旧。
188
189TODOList:
190
191* staging/index
192* watch_queue
193
194目录和表格
195----------
196
197* :ref:`genindex`
198
199.. raw:: latex
200
201	\kerneldocEndSC
202