Documentation/tools/kdoc_parser.rst

File Facts

System

Linux kernel

Corpus path

Documentation/tools/kdoc_parser.rst

Extension

.rst

Size

727 bytes

Lines

38

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

.. SPDX-License-Identifier: GPL-2.0

=======================
Kernel-doc parser stage
=======================

C replacement rules used by the parser
======================================

.. automodule:: lib.python.kdoc.xforms_lists
   :members:
   :show-inheritance:
   :undoc-members:

File handler classes
====================

.. automodule:: lib.python.kdoc.kdoc_files
   :members:
   :show-inheritance:
   :undoc-members:

Parsed item data class
======================

.. automodule:: lib.python.kdoc.kdoc_item
   :members:
   :show-inheritance:
   :undoc-members:

Parser classes and methods
==========================

.. automodule:: lib.python.kdoc.kdoc_parser
   :members:
   :show-inheritance:
   :undoc-members:

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.