Documentation/translations/zh_CN/index.rst

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