Skip to content

Commit

Permalink
doc: include checkpatch & cspf docs in toctree
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
qlyoung committed Sep 27, 2023
1 parent d2292c6 commit e45651f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/developer/checkpatch.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0-only
.. _checkpatch:

==========
Checkpatch
==========
Expand Down
1 change: 1 addition & 0 deletions doc/developer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ FRRouting Developer's Guide
:maxdepth: 2

workflow
checkpatch
building
packaging
process-architecture
Expand Down
1 change: 1 addition & 0 deletions doc/developer/ospf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ OSPFD

ospf-api
ospf-sr
cspf

2 changes: 2 additions & 0 deletions doc/developer/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e45651f

Please sign in to comment.