summaryrefslogtreecommitdiffstats
path: root/doc/developer
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@qlyoung.net>2023-09-28 01:54:02 +0200
committerQuentin Young <qlyoung@qlyoung.net>2023-09-28 01:55:35 +0200
commite45651fbd0681244be1dd98834657c1e38e60e8b (patch)
tree0c370201e834acfd7571e0db3cc61c07ef7e1acc /doc/developer
parentdoc: fix whitespace, formatting errors (diff)
downloadfrr-e45651fbd0681244be1dd98834657c1e38e60e8b.tar.xz
frr-e45651fbd0681244be1dd98834657c1e38e60e8b.zip
doc: include checkpatch & cspf docs in toctree
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>
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/checkpatch.rst2
-rw-r--r--doc/developer/index.rst1
-rw-r--r--doc/developer/ospf.rst1
-rw-r--r--doc/developer/workflow.rst2
4 files changed, 6 insertions, 0 deletions
diff --git a/doc/developer/checkpatch.rst b/doc/developer/checkpatch.rst
index b52452bc2..d8fe007c3 100644
--- a/doc/developer/checkpatch.rst
+++ b/doc/developer/checkpatch.rst
@@ -1,5 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0-only
+.. _checkpatch:
+
==========
Checkpatch
==========
diff --git a/doc/developer/index.rst b/doc/developer/index.rst
index c2123f1ad..bd794b11a 100644
--- a/doc/developer/index.rst
+++ b/doc/developer/index.rst
@@ -5,6 +5,7 @@ FRRouting Developer's Guide
:maxdepth: 2
workflow
+ checkpatch
building
packaging
process-architecture
diff --git a/doc/developer/ospf.rst b/doc/developer/ospf.rst
index a5164d552..837a0bd18 100644
--- a/doc/developer/ospf.rst
+++ b/doc/developer/ospf.rst
@@ -9,4 +9,5 @@ OSPFD
ospf-api
ospf-sr
+ cspf
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst
index e26486efd..68834ed71 100644
--- a/doc/developer/workflow.rst
+++ b/doc/developer/workflow.rst
@@ -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