summaryrefslogtreecommitdiffstats
path: root/doc/developer/topotests.rst
diff options
context:
space:
mode:
authorDavid Lamparter <equinox@opensourcerouting.org>2021-10-14 19:11:02 +0200
committerDavid Lamparter <equinox@opensourcerouting.org>2021-10-14 19:12:01 +0200
commite8713b62d1f09326a94f51b150cb6a63fbcfa2a3 (patch)
tree7722c7fd58506ec1b39b7d4a9683f7e54f7bb9dd /doc/developer/topotests.rst
parentdoc/developer: fix C struct references (diff)
downloadfrr-e8713b62d1f09326a94f51b150cb6a63fbcfa2a3.tar.xz
frr-e8713b62d1f09326a94f51b150cb6a63fbcfa2a3.zip
doc/developer: fix warnings in topotests doc
Sphinx warns about a few nits here, just fix. (Note :option:`-E` can't be used without a "option:: -E" definition, it's intended as a cross reference.) Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
Diffstat (limited to 'doc/developer/topotests.rst')
-rw-r--r--doc/developer/topotests.rst11
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index b4f6ec521..d8b365094 100644
--- a/doc/developer/topotests.rst
+++ b/doc/developer/topotests.rst
@@ -137,14 +137,14 @@ Topotests must be run as root. Normally this will be accomplished through the
use of the ``sudo`` command. In order for topotests to be able to open new
windows (either XTerm or byobu/screen/tmux windows) certain environment
variables must be passed through the sudo command. One way to do this is to
-specify the :option:`-E` flag to ``sudo``. This will carry over most if not all
+specify the ``-E`` flag to ``sudo``. This will carry over most if not all
your environment variables include ``PATH``. For example:
.. code:: shell
sudo -E python3 -m pytest -s -v
-If you do not wish to use :option:`-E` (e.g., to avoid ``sudo`` inheriting
+If you do not wish to use ``-E`` (e.g., to avoid ``sudo`` inheriting
``PATH``) you can modify your `/etc/sudoers` config file to specifically pass
the environment variables required by topotests. Add the following commands to
your ``/etc/sudoers`` config file.
@@ -197,7 +197,7 @@ the run.
Here we see that 4 tests have failed. We an dig deeper by displaying the
captured logs and errors. First let's redisplay the results enumerated by adding
-the :option:`-E` flag
+the ``-E`` flag
.. code:: shell
@@ -385,7 +385,7 @@ to launch the given programs.
NOTE: you must run the topotest (pytest) such that your DISPLAY, STY or TMUX
environment variables are carried over. You can do this by passing the
-:option:`-E` flag to ``sudo`` or you can modify your ``/etc/sudoers`` config to
+``-E`` flag to ``sudo`` or you can modify your ``/etc/sudoers`` config to
automatically pass that environment variable through to the ``sudo``
environment.
@@ -903,6 +903,7 @@ Interface), from here you can call your router ``vtysh`` or even bash.
Here's the help text:
.. code:: shell
+
unet> help
Commands:
@@ -912,8 +913,6 @@ Here's the help text:
vtysh [hosts] :: open vtysh terminals for hosts
[hosts] <vtysh-command> :: execute vtysh-command on hosts
-.. code:: shell
-
Here are some commands example:
.. code:: shell