]> git.puffer.fish Git - matthieu/frr.git/commitdiff
doc: include checkpatch & cspf docs in toctree
authorQuentin Young <qlyoung@qlyoung.net>
Wed, 27 Sep 2023 23:54:02 +0000 (19:54 -0400)
committerQuentin Young <qlyoung@qlyoung.net>
Wed, 27 Sep 2023 23:55:35 +0000 (19:55 -0400)
The documentation pages on checkpatch and CSPF were not reachable
because they were not included in any toctree. Include them in the tree!

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
doc/developer/checkpatch.rst
doc/developer/index.rst
doc/developer/ospf.rst
doc/developer/workflow.rst

index b52452bc29636c592b0e6755c8da5e2a30179724..d8fe007c31317092ae8c08ee7c4759781d649ddd 100644 (file)
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0-only
 
+.. _checkpatch:
+
 ==========
 Checkpatch
 ==========
index c2123f1ad20978b50bf87de1f8902cff69b966e7..bd794b11a8dfe8bf0d21444e04d885dc304e6170 100644 (file)
@@ -5,6 +5,7 @@ FRRouting Developer's Guide
    :maxdepth: 2
 
    workflow
+   checkpatch
    building
    packaging
    process-architecture
index a5164d552a184114d197336702447826ee81ec13..837a0bd18598f3cdc5b9a73a70b39ce03ff4967b 100644 (file)
@@ -9,4 +9,5 @@ OSPFD
 
    ospf-api
    ospf-sr
+   cspf
 
index e26486efdec553103fd0a125c029e524fc4e1066..68834ed710962540f118bfab1e594e9833cd764a 100644 (file)
@@ -876,6 +876,8 @@ clang-format
 checkpatch.sh
 checkpatch.pl
 
+   .. seealso:: :ref:`checkpatch`
+
    In the Linux kernel source tree there is a Perl script used to check
    incoming patches for style errors. FRR uses a shell script front end and an
    adapted version of the perl script for the same purpose. These scripts can