mirror of
https://github.com/torvalds/linux.git
synced 2026-01-25 15:03:52 +08:00
c4f72d3747
Mauro Carvalho Chehab says: ==================== add a generic yaml parser integrated with Netlink specs generation - An YAML parser Sphinx plugin, integrated with Netlink YAML doc parser. The patch content is identical to my v10 submission: https://lore.kernel.org/cover.1753718185.git.mchehab+huawei@kernel.org * tag 'docs/v6.17-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-docs: sphinx: parser_yaml.py: fix line numbers information docs: parser_yaml.py: fix backward compatibility with old docutils docs: parser_yaml.py: add support for line numbers from the parser tools: netlink_yml_parser.py: add line numbers to parsed data MAINTAINERS: add netlink_yml_parser.py to linux-doc docs: netlink: remove obsolete .gitignore from unused directory tools: ynl_gen_rst.py: drop support for generating index files docs: uapi: netlink: update netlink specs link docs: use parser_yaml extension to handle Netlink specs docs: sphinx: add a parser for yaml files for Netlink specs tools: ynl_gen_rst.py: cleanup coding style docs: netlink: index.rst: add a netlink index file tools: ynl_gen_rst.py: Split library from command line tool docs: netlink: netlink-raw.rst: use :ref: instead of :doc: ==================== Link: https://patch.msgid.link/20250812113329.356c93c2@foz.lan Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Linux kernel
============
There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
There are various text files in the Documentation/ subdirectory,
several of them using the reStructuredText markup notation.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.