Commit e8c780a5 authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

docs: netlink: link to family documentations from spec info 



To increase the chances of people finding the rendered docs
add a link to specs.rst and index.rst.

Add a label in the generated index.rst and while at it adjust
the title a little bit.

Reviewed-by: default avatarBreno Leitao <leitao@debian.org>
Reviewed-by: default avatarDonald Hunter <donald.hunter@gmail.com>
Reviewed-by: default avatarJiri Pirko <jiri@nvidia.com>
Link: https://lore.kernel.org/r/20231129041427.2763074-1-kuba@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 981239ee

Documentation/userspace-api/netlink/index.rst

+3 −1
Original line number Diff line number Diff line
@@ -16,4 +16,6 @@ Netlink documentation for users. 
   genetlink-legacy

   netlink-raw



See also :ref:`Documentation/core-api/netlink.rst <kernel_netlink>`.
 
See also:

 - :ref:`Documentation/core-api/netlink.rst <kernel_netlink>`

 - :ref:`Documentation/networking/netlink_spec/index.rst <specs>`

Documentation/userspace-api/netlink/specs.rst

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ kernel headers directly. 
Internally kernel uses the YAML specs to generate:



 - the C uAPI header

 - documentation of the protocol as a ReST file

 - documentation of the protocol as a ReST file - see :ref:`Documentation/networking/netlink_spec/index.rst <specs>`

 - policy tables for input attribute validation

 - operation tables

tools/net/ynl/ynl-gen-rst.py

+7 −1
Original line number Diff line number Diff line
@@ -122,6 +122,11 @@ def rst_toctree(maxdepth: int = 2) -> str: 
    return "\n".join(lines)





def rst_label(title: str) -> str:

    """Return a formatted label"""

    return f".. _{title}:\n\n"





# Parsers

# =======
@@ -349,7 +354,8 @@ def generate_main_index_rst(output: str) -> None: 
    lines = []



    lines.append(rst_header())

    lines.append(rst_title("Netlink Specification"))

    lines.append(rst_label("specs"))

    lines.append(rst_title("Netlink Family Specifications"))

    lines.append(rst_toctree(1))



    index_dir = os.path.dirname(output)