linux/tools/net/ynl
Donald Hunter 4cc1730a90 doc: netlink: Change generated docs to limit TOC to depth 3
The tables of contents in the generated Netlink docs include individual
attribute definitions. This can make the contents exceedingly long and
repeats a lot of what is on the rest of the pages. See for example:

https://docs.kernel.org/networking/netlink_spec/tc.html

Add a depth limit to the contents directive in generated .rst files to
limit the contents depth to 3 levels. This reduces the contents to:

 - Family
   - Summary
   - Operations
     - op-one
     - op-two
     - ...
   - Definitions
     - struct-one
     - struct-two
     - enum-one
     - ...
   - Attribute sets
     - attrs-one
     - attrs-two
     - ...

Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
Reviewed-by: Breno Leitao <leitao@debian.org>
Link: https://lore.kernel.org/r/20240329135021.52534-2-donald.hunter@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
2024-04-01 21:26:01 -07:00
..
generated tools: ynl: rename make hardclean -> distclean 2024-03-06 12:05:10 +00:00
lib tools/net/ynl: Add extack policy attribute decoding 2024-03-29 12:26:02 -07:00
samples ynl: samples: fix recycling rate calculation 2024-03-11 10:22:06 +00:00
cli.py tools/net/ynl: Report netlink errors without stacktrace 2024-03-07 20:28:26 -08:00
ethtool.py tools: ynl: Rename ethtool to ethtool.py 2023-04-13 22:18:29 -07:00
Makefile tools: ynl: add distclean to .PHONY in all makefiles 2024-03-06 12:05:10 +00:00
Makefile.deps tools: ynl: add header guards for nlctrl 2024-03-19 11:33:02 +01:00
requirements.txt tools: ynl: add the Python requirements.txt file 2023-03-24 19:11:02 -07:00
ynl-gen-c.py tools: ynl: fix setting presence bits in simple nests 2024-03-22 17:54:38 -07:00
ynl-gen-rst.py doc: netlink: Change generated docs to limit TOC to depth 3 2024-04-01 21:26:01 -07:00
ynl-regen.sh tools: ynl: don't skip regeneration from make targets 2023-11-29 16:07:00 -08:00