diff options
author | Mark Stapp <mjs@cisco.com> | 2024-09-10 21:21:03 +0200 |
---|---|---|
committer | Mark Stapp <mjs@cisco.com> | 2024-09-10 21:21:03 +0200 |
commit | d27ce6b7be217f355fa2ab3f0f6cfb8d3af12d69 (patch) | |
tree | aa0aed579dce7094d349bdccd9a9ffffd2677ac6 /doc | |
parent | Merge pull request #16718 from louis-6wind/fix-asla-length (diff) | |
download | frr-d27ce6b7be217f355fa2ab3f0f6cfb8d3af12d69.tar.xz frr-d27ce6b7be217f355fa2ab3f0f6cfb8d3af12d69.zip |
doc: fix several warnings in dev docs
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>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/developer/bgpd.rst | 1 | ||||
-rw-r--r-- | doc/developer/mgmtd-dev.rst | 2 | ||||
-rw-r--r-- | doc/developer/northbound/yang-tools.rst | 4 | ||||
-rw-r--r-- | doc/developer/topotests.rst | 8 |
4 files changed, 8 insertions, 7 deletions
diff --git a/doc/developer/bgpd.rst b/doc/developer/bgpd.rst index a35fa614f..f5263ff31 100644 --- a/doc/developer/bgpd.rst +++ b/doc/developer/bgpd.rst @@ -9,3 +9,4 @@ BGPD next-hop-tracking bgp-typecodes + bmp diff --git a/doc/developer/mgmtd-dev.rst b/doc/developer/mgmtd-dev.rst index b979af06f..4c56cadb2 100644 --- a/doc/developer/mgmtd-dev.rst +++ b/doc/developer/mgmtd-dev.rst @@ -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: diff --git a/doc/developer/northbound/yang-tools.rst b/doc/developer/northbound/yang-tools.rst index fb5a28724..91a767dce 100644 --- a/doc/developer/northbound/yang-tools.rst +++ b/doc/developer/northbound/yang-tools.rst @@ -87,7 +87,7 @@ Generate skeleton instance data: * XML: - .. code:: sh +.. code:: sh $ pyang -p <yang-search-path> \ -f sample-xml-skeleton --sample-xml-skeleton-defaults \ @@ -95,7 +95,7 @@ Generate skeleton instance data: * JSON: - .. code:: sh +.. code:: sh $ pyang -p <yang-search-path> \ -f jsonxsl module.yang -o module.xsl diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 4f9c94ca0..620974963 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -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. @@ -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`` @@ -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 |