Documentation/translations/zh_CN/doc-guide/index.rst

File Facts

System

Linux kernel

Corpus path

Documentation/translations/zh_CN/doc-guide/index.rst

Extension

.rst

Size

417 bytes

Lines

29

Domain

Support Tooling And Documentation

Bucket

Documentation

Inferred role

Support Tooling And Documentation: documentation

Status

atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

• Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

• No C-style include directives detected by the generator.

Detected Declarations

• No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

.. include:: ../disclaimer-zh_CN.rst

:Original: Documentation/doc-guide/index.rst

:译者: 吴想成 Wu XiangCheng <bobwxc@email.cn>

.. _doc_guide_zh:

================
如何编写内核文档
================

.. toctree::
   :maxdepth: 1

   sphinx
   kernel-doc
   parse-headers
   contributing
   maintainer-profile
   checktransupdate

.. only::  subproject and html

   目录
   ====

   * :ref:`genindex`

Annotation

• Atlas domain: Support Tooling And Documentation / Documentation.
• Implementation status: atlas-only.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.