diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2025-06-10 11:42:30 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2025-08-12 07:47:30 +0200 |
| commit | dd5d5a11bacb2eb0e00e0f6a9bc919afed2ec751 (patch) | |
| tree | 5b690c46f2d2cb38d27308816162fd7b89015344 /tools/net/ynl/pyynl/ynl_gen_rst.py | |
| parent | Linux 6.17-rc1 (diff) | |
| download | linux-dd5d5a11bacb2eb0e00e0f6a9bc919afed2ec751.tar.gz linux-dd5d5a11bacb2eb0e00e0f6a9bc919afed2ec751.zip | |
docs: netlink: netlink-raw.rst: use :ref: instead of :doc:
Currently, rt documents are referred with:
Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`rt-link<../../networking/netlink_spec/rt-link>`
Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`tc<../../networking/netlink_spec/tc>`
Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`tc<../../networking/netlink_spec/tc>`
Having :doc: references with relative paths doesn't always work,
as it may have troubles when O= is used. Also that's hard to
maintain, and may break if we change the way rst files are
generated from yaml. Better to use instead a reference for
the netlink family.
So, replace them by Sphinx cross-reference tag that are
created by ynl_gen_rst.py.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Donald Hunter <donald.hunter@gmail.com>
Diffstat (limited to 'tools/net/ynl/pyynl/ynl_gen_rst.py')
| -rwxr-xr-x | tools/net/ynl/pyynl/ynl_gen_rst.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/tools/net/ynl/pyynl/ynl_gen_rst.py b/tools/net/ynl/pyynl/ynl_gen_rst.py index 0cb6348e28d3..7bfb8ceeeefc 100755 --- a/tools/net/ynl/pyynl/ynl_gen_rst.py +++ b/tools/net/ynl/pyynl/ynl_gen_rst.py @@ -314,10 +314,11 @@ def parse_yaml(obj: Dict[str, Any]) -> str: # Main header - lines.append(rst_header()) - family = obj['name'] + lines.append(rst_header()) + lines.append(rst_label("netlink-" + family)) + title = f"Family ``{family}`` netlink specification" lines.append(rst_title(title)) lines.append(rst_paragraph(".. contents:: :depth: 3\n")) |
