]> git.ipfire.org Git - thirdparty/linux.git/commit
docs: netlink: netlink-raw.rst: use :ref: instead of :doc:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 10 Jun 2025 09:42:30 +0000 (11:42 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 12 Aug 2025 05:47:30 +0000 (07:47 +0200)
commitdd5d5a11bacb2eb0e00e0f6a9bc919afed2ec751
tree5b690c46f2d2cb38d27308816162fd7b89015344
parent8f5ae30d69d7543eee0d70083daf4de8fe15d585
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>
Documentation/userspace-api/netlink/netlink-raw.rst
tools/net/ynl/pyynl/ynl_gen_rst.py