diff options
| author | Quentin Young <qlyoung@qlyoung.net> | 2023-09-27 19:54:02 -0400 |
|---|---|---|
| committer | Quentin Young <qlyoung@qlyoung.net> | 2023-09-27 19:55:35 -0400 |
| commit | e45651fbd0681244be1dd98834657c1e38e60e8b (patch) | |
| tree | 0c370201e834acfd7571e0db3cc61c07ef7e1acc | |
| parent | d2292c6bfee5f3e82e236bf679a9ed0980032f17 (diff) | |
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>
| -rw-r--r-- | doc/developer/checkpatch.rst | 2 | ||||
| -rw-r--r-- | doc/developer/index.rst | 1 | ||||
| -rw-r--r-- | doc/developer/ospf.rst | 1 | ||||
| -rw-r--r-- | doc/developer/workflow.rst | 2 |
4 files changed, 6 insertions, 0 deletions
diff --git a/doc/developer/checkpatch.rst b/doc/developer/checkpatch.rst index b52452bc29..d8fe007c31 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 c2123f1ad2..bd794b11a8 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 a5164d552a..837a0bd185 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 e26486efde..68834ed710 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 |