As discussed at: https://lore.kernel.org/all/20250610101331.62ba466f@xxxxxxx/ changeset f061c9f7d058 ("Documentation: Document each netlink family") added a logic which generates *.rst files inside $(srctree). This is bad when O=<BUILDDIR> is used. A recent change renamed the yaml files used by Netlink, revealing a bad side effect: as "make cleandocs" don't clean the produced files and symbols appear duplicated for people that don't build the kernel from scratch. This series adds an yaml parser extension. We opted to write such extension in a way that no actual yaml conversion code is inside it. This makes it flexible enough to handle other types of yaml files in the future. The actual yaml conversion logic were placed at scripts/lib/netlink_yml_parser.py. The existing command line tool was also modified to use the library ther. With this version, there's no need to add any template file per netlink/spec file, and the index is automatically filled using :glob: parameter. --- v4: - Renamed the YNL parser class; - some minor patch cleanups and merges; - added an extra patch to fix a insert_pattern/exclude_pattern logic when SPHINXDIRS is used. v3: - Two series got merged altogether: - https://lore.kernel.org/linux-doc/cover.1749723671.git.mchehab+huawei@xxxxxxxxxx/T/#t - https://lore.kernel.org/linux-doc/cover.1749735022.git.mchehab+huawei@xxxxxxxxxx - Added an extra patch to update MAINTAINERS to point to YNL library - Added a (somewhat unrelated) patch that remove warnings check when running "make cleandocs". --- v2: - Use a Sphinx extension to handle netlink files. v1: - Statically add template files to as networking/netlink_spec/<family>.rst Mauro Carvalho Chehab (14): tools: ynl_gen_rst.py: create a top-level reference docs: netlink: netlink-raw.rst: use :ref: instead of :doc: docs: netlink: don't ignore generated rst files tools: ynl_gen_rst.py: make the index parser more generic tools: ynl_gen_rst.py: Split library from command line tool scripts: lib: netlink_yml_parser.py: use classes tools: ynl_gen_rst.py: move index.rst generator to the script docs: sphinx: add a parser for yaml files for Netlink specs docs: use parser_yaml extension to handle Netlink specs docs: conf.py: don't handle yaml files outside Netlink specs docs: uapi: netlink: update netlink specs link MAINTAINERS: add maintainers for netlink_yml_parser.py docs: Makefile: disable check rules on make cleandocs docs: conf.py: properly handle include and exclude patterns .pylintrc | 2 +- Documentation/Makefile | 19 +- Documentation/conf.py | 61 ++- Documentation/netlink/specs/index.rst | 13 + Documentation/networking/index.rst | 2 +- .../networking/netlink_spec/.gitignore | 1 - .../networking/netlink_spec/readme.txt | 4 - Documentation/sphinx/parser_yaml.py | 76 ++++ Documentation/userspace-api/netlink/index.rst | 2 +- .../userspace-api/netlink/netlink-raw.rst | 6 +- Documentation/userspace-api/netlink/specs.rst | 2 +- MAINTAINERS | 2 + scripts/lib/netlink_yml_parser.py | 360 ++++++++++++++++ tools/net/ynl/pyynl/ynl_gen_rst.py | 394 ++---------------- 14 files changed, 548 insertions(+), 396 deletions(-) create mode 100644 Documentation/netlink/specs/index.rst delete mode 100644 Documentation/networking/netlink_spec/.gitignore delete mode 100644 Documentation/networking/netlink_spec/readme.txt create mode 100755 Documentation/sphinx/parser_yaml.py create mode 100755 scripts/lib/netlink_yml_parser.py -- 2.49.0
