顺便说下，中文文档也需要遵守内核编码风格，风格中中文和英文的主要不同就是中文
的字符标点占用两个英文字符宽度， 所以，当英文要求不要超过每行100个字符时，
中文就不要超过50个字符。另外，也要注意'-'，'=' 等符号与相关标题的对齐。在将
-补丁提交到社区之前，一定要进行必要的checkpatch.pl检查和编译测试。
+补丁提交到社区之前，一定要进行必要的 ``checkpatch.pl`` 检查和编译测试。
-许可证文档
-----------
-
-下面的文档介绍了Linux内核源代码的许可证（GPLv2）、如何在源代码树中正确标记
-单个文件的许可证、以及指向完整许可证文本的链接。
+与Linux 内核社区一起工作
+------------------------
-* Documentation/translations/zh_CN/process/license-rules.rst
-
-用户文档
---------
-
-下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
-用户。
+与内核开发社区进行协作并将工作推向上游的基本指南。
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- admin-guide/index
-
-TODOList:
-
-* kbuild/index
+ process/development-process
+ process/submitting-patches
+ 行为准则 <process/code-of-conduct>
+ maintainer/index
+ 完整开发流程文档 <process/index>
-å\9bºä»¶ç\9b¸å\85³文档
-------------
+å\86\85é\83¨API文档
+-----------
-下列文档描述了内核需要的平台固件相关信息。
+开发人员使用的内核内部交互接口手册。
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- devicetree/index
+ core-api/index
+ driver-api/index
+ 内核中的锁 <locking/index>
TODOList:
-* firmware-guide/index
-
-应用程序开发人员文档
---------------------
-
-用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。
-
-TODOlist:
-
-* userspace-api/index
+* subsystem-apis
-å\86\85æ ¸å¼\80å\8f\91ç®\80ä»\8b
-------------
+å¼\80å\8f\91å·¥å\85·å\92\8cæµ\81ç¨\8b
+--------------
-这些手册包含有关如何开发内核的整体信息。内核社区非常庞大，一年下来有数千名
-开发人员做出贡献。与任何大型社区一样，知道如何完成任务将使得更改合并的过程
-变得更加容易。
+为所有内核开发人员提供有用信息的各种其他手册。
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- process/index
- dev-tools/index
+ process/license-rules
doc-guide/index
+ dev-tools/index
+ dev-tools/testing-overview
kernel-hacking/index
- maintainer/index
TODOList:
* trace/index
* fault-injection/index
* livepatch/index
-* rust/index
-内核API文档
------------
+面向用户的文档
+--------------
-以ä¸\8bæ\89\8bå\86\8cä»\8eå\86\85æ ¸å¼\80å\8f\91人å\91\98ç\9a\84è§\92度详ç»\86ä»\8bç»\8däº\86ç\89¹å®\9aç\9a\84å\86\85æ ¸å\90ç³»ç»\9fæ\98¯å¦\82ä½\95å·¥ä½\9cç\9a\84ã\80\82è¿\99é\87\8cç\9a\84
-大é\83¨å\88\86ä¿¡æ\81¯é\83½æ\98¯ç\9b´æ\8e¥ä»\8eå\86\85æ ¸æº\90代ç \81è\8e·å\8f\96ç\9a\84ï¼\8cå¹¶æ ¹æ\8d®é\9c\80è¦\81æ·»å\8a è¡¥å\85\85æ\9d\90æ\96\99ï¼\88æ\88\96è\80\85è\87³å°\91æ\98¯å\9c¨
-我们设法添加的时候——可能不是所有的都是有需要的）。
+ä¸\8bå\88\97æ\89\8bå\86\8cé\92\88对
+å¸\8cæ\9c\9bå\86\85æ ¸å\9c¨ç»\99å®\9aç³»ç»\9fä¸\8a以æ\9c\80ä½³æ\96¹å¼\8få·¥ä½\9cç\9a\84*ç\94¨æ\88·*ï¼\8c
+和查找内核用户空间API信息的程序开发人员。
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- core-api/index
- driver-api/index
- locking/index
- accounting/index
- cpu-freq/index
- iio/index
- infiniband/index
- power/index
- virt/index
- sound/index
- filesystems/index
- scheduler/index
- mm/index
- peci/index
- PCI/index
+ admin-guide/index
+ admin-guide/reporting-issues.rst
TODOList:
-* block/index
-* cdrom/index
-* ide/index
-* fb/index
-* fpga/index
-* hid/index
-* i2c/index
-* isdn/index
-* leds/index
-* netlabel/index
-* networking/index
-* pcmcia/index
-* target/index
-* timers/index
-* spi/index
-* w1/index
-* watchdog/index
-* input/index
-* hwmon/index
-* gpu/index
-* security/index
-* crypto/index
-* bpf/index
-* usb/index
-* scsi/index
-* misc-devices/index
-* mhi/index
-
-体系结构无关文档
-----------------
-
-TODOList:
+* 内核构建系统 <kbuild/index>
+* 用户空间工具 <tools/index>
+* userspace-api/index
-* asm-annotations
+固件相关文档
+------------
-特定体系结构文档
-----------------
+下列文档描述了内核需要的平台固件相关信息。
.. toctree::
:maxdepth: 2
- mips/index
- arm64/index
- riscv/index
- openrisc/index
- parisc/index
- loongarch/index
+ devicetree/index
TODOList:
-* arm/index
-* ia64/index
-* m68k/index
-* nios2/index
-* powerpc/index
-* s390/index
-* sh/index
-* sparc/index
-* x86/index
-* xtensa/index
+* firmware-guide/index
+
+体系结构文档
+------------
+
+.. toctree::
+ :maxdepth: 2
+
+ arch
其他文档
--------
TODOList:
* staging/index
-* watch_queue
-目录和表格
+
+索引和表格
----------
* :ref:`genindex`
projects / platform / kernel / linux-starfive.git / commitdiff