Re: [PATCH v7 03/17] docs: netlink: netlink-raw.rst: use :ref: instead of :doc:
Donald Hunter <[email protected]>
| Newsgroups | dev.linux.lists.lkmm,dev.linux.lists.linux-kernel-mentees,org.kernel.vger.linux-doc,org.kernel.vger.linux-kernel,org.kernel.vger.netdev |
|---|---|
| Message-ID | <[email protected]> |
Mauro Carvalho Chehab <[email protected]> writes: > 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 <[email protected]> Reviewed-by: Donald Hunter <[email protected]>