0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 .. raw:: latex
0004
0005 \renewcommand\thesection*
0006 \renewcommand\thesubsection*
0007 \kerneldocCJKon
0008 \kerneldocBeginSC{
0009
0010 .. _linux_doc_zh:
0011
0012 中文翻译
0013 ========
0014
0015
0016 .. note::
0017
0018 **翻译计划:**
0019 内核中文文档欢迎任何翻译投稿，特别是关于内核用户和管理员指南部分。
0020
0021 这是中文内核文档树的顶级目录。内核文档，就像内核本身一样，在很大程度上是一
0022 项正在进行的工作；当我们努力将许多分散的文件整合成一个连贯的整体时尤其如此。
0023 另外，随时欢迎您对内核文档进行改进；如果您想提供帮助，请加入vger.kernel.org
0024 上的linux-doc邮件列表。
0025
0026 顺便说下，中文文档也需要遵守内核编码风格，风格中中文和英文的主要不同就是中文
0027 的字符标点占用两个英文字符宽度， 所以，当英文要求不要超过每行100个字符时，
0028 中文就不要超过50个字符。另外，也要注意'-'，'=' 等符号与相关标题的对齐。在将
0029 补丁提交到社区之前，一定要进行必要的checkpatch.pl检查和编译测试。
0030
0031 许可证文档
0032 ----------
0033
0034 下面的文档介绍了Linux内核源代码的许可证（GPLv2）、如何在源代码树中正确标记
0035 单个文件的许可证、以及指向完整许可证文本的链接。
0036
0037 * Documentation/translations/zh_CN/process/license-rules.rst
0038
0039 用户文档
0040 --------
0041
0042 下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
0043 用户。
0044
0045 .. toctree::
0046 :maxdepth: 2
0047
0048 admin-guide/index
0049
0050 TODOList:
0051
0052 * kbuild/index
0053
0054 固件相关文档
0055 ------------
0056
0057 下列文档描述了内核需要的平台固件相关信息。
0058
0059 .. toctree::
0060 :maxdepth: 2
0061
0062 devicetree/index
0063
0064 TODOList:
0065
0066 * firmware-guide/index
0067
0068 应用程序开发人员文档
0069 --------------------
0070
0071 用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。
0072
0073 TODOlist:
0074
0075 * userspace-api/index
0076
0077 内核开发简介
0078 ------------
0079
0080 这些手册包含有关如何开发内核的整体信息。内核社区非常庞大，一年下来有数千名
0081 开发人员做出贡献。与任何大型社区一样，知道如何完成任务将使得更改合并的过程
0082 变得更加容易。
0083
0084 .. toctree::
0085 :maxdepth: 2
0086
0087 process/index
0088 dev-tools/index
0089 doc-guide/index
0090 kernel-hacking/index
0091 maintainer/index
0092
0093 TODOList:
0094
0095 * trace/index
0096 * fault-injection/index
0097 * livepatch/index
0098 * rust/index
0099
0100 内核API文档
0101 -----------
0102
0103 以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的
0104 大部分信息都是直接从内核源代码获取的，并根据需要添加补充材料（或者至少是在
0105 我们设法添加的时候——可能不是所有的都是有需要的）。
0106
0107 .. toctree::
0108 :maxdepth: 2
0109
0110 core-api/index
0111 locking/index
0112 accounting/index
0113 cpu-freq/index
0114 iio/index
0115 infiniband/index
0116 power/index
0117 virt/index
0118 sound/index
0119 filesystems/index
0120 scheduler/index
0121 mm/index
0122 peci/index
0123
0124 TODOList:
0125
0126 * driver-api/index
0127 * block/index
0128 * cdrom/index
0129 * ide/index
0130 * fb/index
0131 * fpga/index
0132 * hid/index
0133 * i2c/index
0134 * isdn/index
0135 * leds/index
0136 * netlabel/index
0137 * networking/index
0138 * pcmcia/index
0139 * target/index
0140 * timers/index
0141 * spi/index
0142 * w1/index
0143 * watchdog/index
0144 * input/index
0145 * hwmon/index
0146 * gpu/index
0147 * security/index
0148 * crypto/index
0149 * bpf/index
0150 * usb/index
0151 * PCI/index
0152 * scsi/index
0153 * misc-devices/index
0154 * mhi/index
0155
0156 体系结构无关文档
0157 ----------------
0158
0159 TODOList:
0160
0161 * asm-annotations
0162
0163 特定体系结构文档
0164 ----------------
0165
0166 .. toctree::
0167 :maxdepth: 2
0168
0169 mips/index
0170 arm64/index
0171 riscv/index
0172 openrisc/index
0173 parisc/index
0174 loongarch/index
0175
0176 TODOList:
0177
0178 * arm/index
0179 * ia64/index
0180 * m68k/index
0181 * nios2/index
0182 * powerpc/index
0183 * s390/index
0184 * sh/index
0185 * sparc/index
0186 * x86/index
0187 * xtensa/index
0188
0189 其他文档
0190 --------
0191
0192 有几份未排序的文档似乎不适合放在文档的其他部分，或者可能需要进行一些调整和/或
0193 转换为reStructureText格式，也有可能太旧。
0194
0195 TODOList:
0196
0197 * staging/index
0198 * watch_queue
0199
0200 目录和表格
0201 ----------
0202
0203 * :ref:`genindex`
0204
0205 .. raw:: latex
0206
0207 }\kerneldocEndSC
