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 与Linux 内核社区一起工作
  32 ------------------------
  33
  34 与内核开发社区进行协作并将工作推向上游的基本指南。
  35
  36 .. toctree::
  37    :maxdepth: 1
  38
  39    process/development-process
  40    process/submitting-patches
  41    行为准则 <process/code-of-conduct>
  42    maintainer/index
  43    完整开发流程文档 <process/index>
  44
  45 内部API文档
  46 -----------
  47
  48 开发人员使用的内核内部交互接口手册。
  49
  50 .. toctree::
  51    :maxdepth: 1
  52
  53    core-api/index
  54    driver-api/index
  55    内核中的锁 <locking/index>
  56
  57 TODOList:
  58
  59 * subsystem-apis
  60
  61 开发工具和流程
  62 --------------
  63
  64 为所有内核开发人员提供有用信息的各种其他手册。
  65
  66 .. toctree::
  67    :maxdepth: 1
  68
  69    process/license-rules
  70    doc-guide/index
  71    dev-tools/index
  72    dev-tools/testing-overview
  73    kernel-hacking/index
  74
  75 TODOList:
  76
  77 * trace/index
  78 * fault-injection/index
  79 * livepatch/index
  80
  81 面向用户的文档
  82 --------------
  83
  84 下列手册针对
  85 希望内核在给定系统上以最佳方式工作的*用户*，
  86 和查找内核用户空间API信息的程序开发人员。
  87
  88 .. toctree::
  89    :maxdepth: 1
  90
  91    admin-guide/index
  92    admin-guide/reporting-issues.rst
  93
  94 TODOList:
  95
  96 * 内核构建系统 <kbuild/index>
  97 * 用户空间工具 <tools/index>
  98 * userspace-api/index
  99
 100 也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。
 101
 102 固件相关文档
 103 ------------
 104
 105 下列文档描述了内核需要的平台固件相关信息。
 106
 107 .. toctree::
 108    :maxdepth: 2
 109
 110    devicetree/index
 111
 112 TODOList:
 113
 114 * firmware-guide/index
 115
 116 体系结构文档
 117 ------------
 118
 119 .. toctree::
 120    :maxdepth: 2
 121
 122    arch
 123
 124 其他文档
 125 --------
 126
 127 有几份未排序的文档似乎不适合放在文档的其他部分，或者可能需要进行一些调整和/或
 128 转换为reStructureText格式，也有可能太旧。
 129
 130 TODOList:
 131
 132 * staging/index
 133
 134
 135 索引和表格
 136 ----------
 137
 138 * :ref:`genindex`
 139
 140 .. raw:: latex
 141
 142         }\kerneldocEndSC