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