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

doc: fix several warnings in dev docs

Browse Source 
Clean up several sphinx warnings in the dev docs:
add bmp to bgp TOC; fix some indenting; escape some asterisks.

Signed-off-by: Mark Stapp <mjs@cisco.com>
This commit is contained in:
Mark Stapp 2024-09-10 15:21:03 -04:00
parent 571cca28c3
commit d27ce6b7be
4 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/developer/bgpd.rst
View File

@ -9,3 +9,4 @@ BGPD
next-hop-tracking next-hop-tracking
bgp-typecodes bgp-typecodes
bmp

2
doc/developer/mgmtd-dev.rst
View File

@ -147,7 +147,7 @@ Front-End Interface:
- change route_map_init() to route_map_init_new(false) and remove from - change route_map_init() to route_map_init_new(false) and remove from
VTYSH_ROUTE_MAP_CONFIG (leave in VTYSH_ROUTE_MAP_SHOW). VTYSH_ROUTE_MAP_CONFIG (leave in VTYSH_ROUTE_MAP_SHOW).
- remove vrf_cmd_init(NULL) => remove from VTYSH_INTERFACE_SUBSET - remove vrf_cmd_init(NULL) => remove from VTYSH_INTERFACE_SUBSET
...
Back-End Interface: Back-End Interface:

4
doc/developer/northbound/yang-tools.rst
View File

@ -87,7 +87,7 @@ Generate skeleton instance data:
* XML: * XML:
.. code:: sh .. code:: sh
$ pyang -p <yang-search-path> \ $ pyang -p <yang-search-path> \
-f sample-xml-skeleton --sample-xml-skeleton-defaults \ -f sample-xml-skeleton --sample-xml-skeleton-defaults \
@ -95,7 +95,7 @@ Generate skeleton instance data:
* JSON: * JSON:
.. code:: sh .. code:: sh
$ pyang -p <yang-search-path> \ $ pyang -p <yang-search-path> \
-f jsonxsl module.yang -o module.xsl -f jsonxsl module.yang -o module.xsl

8
doc/developer/topotests.rst
View File

@ -731,8 +731,8 @@ packages.
Code coverage can automatically be gathered for any topotest run. To support Code coverage can automatically be gathered for any topotest run. To support
this FRR must first be compiled with the ``--enable-gcov`` configure option. this FRR must first be compiled with the ``--enable-gcov`` configure option.
This will cause *.gnco files to be created during the build. When topotests are This will cause \*.gnco files to be created during the build. When topotests are
run the statistics are generated and stored in *.gcda files. Topotest run the statistics are generated and stored in \*.gcda files. Topotest
infrastructure will gather these files, capture the information into a infrastructure will gather these files, capture the information into a
``coverage.info`` ``lcov`` file and also report the coverage summary. ``coverage.info`` ``lcov`` file and also report the coverage summary.
@ -741,7 +741,7 @@ If you build your FRR in a directory outside of the FRR source directory you
will also need to pass the ``--cov-frr-build-dir`` argument specifying the build will also need to pass the ``--cov-frr-build-dir`` argument specifying the build
directory location. directory location.
During the topotest run the *.gcda files are generated into a ``gcda`` During the topotest run the \*.gcda files are generated into a ``gcda``
sub-directory of the top-level run directory (i.e., normally sub-directory of the top-level run directory (i.e., normally
``/tmp/topotests/gcda``). These files will then be copied at the end of the ``/tmp/topotests/gcda``). These files will then be copied at the end of the
topotest run into the FRR build directory where the ``gcov`` and ``lcov`` topotest run into the FRR build directory where the ``gcov`` and ``lcov``
@ -756,7 +756,7 @@ The ``coverage.info`` file can then be used to generate coverage reports or file
markup (e.g., using the ``genhtml`` utility) or enable markup within your markup (e.g., using the ``genhtml`` utility) or enable markup within your
IDE/editor if supported (e.g., the emacs ``cov-mode`` package) IDE/editor if supported (e.g., the emacs ``cov-mode`` package)
NOTE: the *.gcda files in ``/tmp/topotests/gcda`` are cumulative so if you do NOTE: the \*.gcda files in ``/tmp/topotests/gcda`` are cumulative so if you do
not remove them they will aggregate data across multiple topotest runs. not remove them they will aggregate data across multiple topotest runs.
How to reproduce failed Tests How to reproduce failed Tests