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