proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-07 11:25:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: include checkpatch & cspf docs in toctree

Browse Source 
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>
This commit is contained in:
Quentin Young 2023-09-27 19:54:02 -04:00
parent d2292c6bfe
commit e45651fbd0
4 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/developer/checkpatch.rst
View File

@ -1,5 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0-only .. SPDX-License-Identifier: GPL-2.0-only
.. _checkpatch:
========== ==========
Checkpatch Checkpatch
========== ==========

1
doc/developer/index.rst
View File

@ -5,6 +5,7 @@ FRRouting Developer's Guide
:maxdepth: 2 :maxdepth: 2
workflow workflow
checkpatch
building building
packaging packaging
process-architecture process-architecture

1
doc/developer/ospf.rst
View File

@ -9,4 +9,5 @@ OSPFD
ospf-api ospf-api
ospf-sr ospf-sr
cspf

2
doc/developer/workflow.rst
View File

@ -876,6 +876,8 @@ clang-format
checkpatch.sh checkpatch.sh
checkpatch.pl checkpatch.pl
.. seealso:: :ref:`checkpatch`
In the Linux kernel source tree there is a Perl script used to check 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 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 adapted version of the perl script for the same purpose. These scripts can