Skip to content

Commit

Permalink
doc: fix several warnings in dev docs
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
Mark Stapp committed Sep 10, 2024
1 parent 571cca2 commit d27ce6b
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
1 change: 1 addition & 0 deletions doc/developer/bgpd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ BGPD

next-hop-tracking
bgp-typecodes
bmp
2 changes: 1 addition & 1 deletion doc/developer/mgmtd-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Front-End Interface:
- change route_map_init() to route_map_init_new(false) and remove from
VTYSH_ROUTE_MAP_CONFIG (leave in VTYSH_ROUTE_MAP_SHOW).
- remove vrf_cmd_init(NULL) => remove from VTYSH_INTERFACE_SUBSET
...


Back-End Interface:

Expand Down
4 changes: 2 additions & 2 deletions doc/developer/northbound/yang-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,15 @@ Generate skeleton instance data:

* XML:

.. code:: sh
.. code:: sh
$ pyang -p <yang-search-path> \
-f sample-xml-skeleton --sample-xml-skeleton-defaults \
module.yang [augmented-module1.yang ...] -o module.xml
* JSON:

.. code:: sh
.. code:: sh
$ pyang -p <yang-search-path> \
-f jsonxsl module.yang -o module.xsl
Expand Down
8 changes: 4 additions & 4 deletions doc/developer/topotests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -731,8 +731,8 @@ packages.

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 will cause *.gnco files to be created during the build. When topotests are
run the statistics are generated and stored in *.gcda files. Topotest
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
infrastructure will gather these files, capture the information into a
``coverage.info`` ``lcov`` file and also report the coverage summary.

Expand All @@ -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
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
``/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``
Expand All @@ -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
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.

How to reproduce failed Tests
Expand Down

0 comments on commit d27ce6b

Please sign in to comment.