Merge branch 'docs-mw' into docs-next

.. SPDX-License-Identifier: GPL-2.0

处理器体系结构

==============

以下文档提供了具体架构实现的编程细节。

.. toctree::

   :maxdepth: 2

   mips/index

   arm64/index

   riscv/index

   openrisc/index

   parisc/index

   loongarch/index

TODOList:

* arm/index

* ia64/index

* m68k/index

* nios2/index

* powerpc/index

* s390/index

* sh/index

* sparc/index

* x86/index

* xtensa/index

顺便说下，中文文档也需要遵守内核编码风格，风格中中文和英文的主要不同就是中文

的字符标点占用两个英文字符宽度， 所以，当英文要求不要超过每行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>

固件相关文档

------------

内部API文档

-----------

下列文档描述了内核需要的平台固件相关信息。

开发人员使用的内核内部交互接口手册。

.. toctree::

   :maxdepth: 2

   :maxdepth: 1

   devicetree/index

   core-api/index

   driver-api/index

   内核中的锁 <locking/index>

TODOList:

* firmware-guide/index

应用程序开发人员文档

--------------------

用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。

* subsystem-apis

TODOlist:

开发工具和流程

--------------

* userspace-api/index

内核开发简介

------------

这些手册包含有关如何开发内核的整体信息。内核社区非常庞大，一年下来有数千名

开发人员做出贡献。与任何大型社区一样，知道如何完成任务将使得更改合并的过程

变得更加容易。

为所有内核开发人员提供有用信息的各种其他手册。

.. 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文档

-----------

面向用户的文档

--------------

以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的

大部分信息都是直接从内核源代码获取的，并根据需要添加补充材料（或者至少是在

我们设法添加的时候——可能不是所有的都是有需要的）。

下列手册针对

希望内核在给定系统上以最佳方式工作的*用户*，

和查找内核用户空间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

体系结构无关文档

----------------

* 内核构建系统 <kbuild/index>

* 用户空间工具 <tools/index>

* userspace-api/index

TODOList:

也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。

* 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`

.. _cn_process_index:

========================

与Linux 内核社区一起工作

========================