github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-07 06:17:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

docs: parse-headers: Fix script name and stale Makefile reference

Browse Source 
The script is tools/docs/parse-headers.py, not parse_headers.py, and its
FILE_RULES argument is optional. Commit 8a298579cd ("scripts:
sphinx-build-wrapper: get rid of uapi/media Makefile") removed the
Makefile the text points to as an example; the cross-references are now
generated by the kernel-include directive, so point to a file that uses
it.

Fixes: d69a03a97a ("docs: doc-guide: parse-headers.rst update its documentation")
Fixes: 8a298579cd ("scripts: sphinx-build-wrapper: get rid of uapi/media Makefile")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260905025821.83968-1-kmehltretter@gmail.com>
This commit is contained in:
Karl Mehltretter 2026-09-05 04:58:21 +02:00 committed by Jonathan Corbet
parent 8323704f00
commit bb2e6adb47
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/doc-guide/parse-headers.rst
View File

@ -8,26 +8,27 @@ between the code and the documentation. Adding cross-references for
userspace API files has an additional advantage: Sphinx will generate warnings
if a symbol is not found at the documentation. That helps to keep the
uAPI documentation in sync with the Kernel changes.
The :ref:`parse_headers.py <parse_headers>` provides a way to generate such
cross-references. It has to be called via Makefile, while building the
documentation. Please see ``Documentation/userspace-api/media/Makefile`` for an example
about how to use it inside the Kernel tree.
The :ref:`parse-headers.py <parse_headers>` provides a way to generate such
cross-references. During the documentation build, the same parser is used by
the ``kernel-include`` directive with the ``:generate-cross-refs:`` option.
Please see ``Documentation/userspace-api/media/cec/cec-header.rst`` for an
example about how to use it inside the Kernel tree.
.. _parse_headers:
tools/docs/parse_headers.py
tools/docs/parse-headers.py
^^^^^^^^^^^^^^^^^^^^^^^^^^^
NAME
****
parse_headers.py - parse a C file, in order to identify functions, structs,
parse-headers.py - parse a C file, in order to identify functions, structs,
enums and defines and create cross-references to a Sphinx book.
USAGE
*****
parse-headers.py [-h] [-d] [-t] ``FILE_IN`` ``FILE_OUT`` ``FILE_RULES``
parse-headers.py [-h] [-d] [-t] ``FILE_IN`` ``FILE_OUT`` [``FILE_RULES``]
SYNOPSIS
********