summaryrefslogtreecommitdiffstats
path: root/doc/developer
diff options
context:
space:
mode:
authorChristian Hopps <chopps@labn.net>2023-05-17 19:51:30 +0200
committerChristian Hopps <chopps@labn.net>2023-05-17 19:52:41 +0200
commit9b18d3d6ac4cd4d2f434693fbbab35c8b55f80a6 (patch)
tree6e8bad0f28c23ac30d202cbad61f5bb90bcfc4de /doc/developer
parentMerge pull request #13543 from donaldsharp/clear_up_clear_command (diff)
downloadfrr-9b18d3d6ac4cd4d2f434693fbbab35c8b55f80a6.tar.xz
frr-9b18d3d6ac4cd4d2f434693fbbab35c8b55f80a6.zip
doc: document optionally required packages
- tshark and valgrind are required but only if you enable those features during test runs. Signed-off-by: Christian Hopps <chopps@labn.net>
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/topotests.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index 7b1fde7b5..f44cf9df9 100644
--- a/doc/developer/topotests.rst
+++ b/doc/developer/topotests.rst
@@ -17,13 +17,23 @@ Tested with Ubuntu 20.04,Ubuntu 18.04, and Debian 11.
Instructions are the same for all setups (i.e. ExaBGP is only used for
BGP tests).
+Tshark is only required if you enable any packet captures on test runs.
+
+Valgrind is only required if you enable valgrind on test runs.
+
Installing Topotest Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: shell
- apt-get install gdb iproute2 net-tools python3-pip \
- iputils-ping valgrind
+ apt-get install \
+ gdb \
+ iproute2 \
+ net-tools \
+ python3-pip \
+ iputils-ping \
+ tshark \
+ valgrind
python3 -m pip install wheel
python3 -m pip install 'pytest>=6.2.4'
python3 -m pip install 'pytest-xdist>=2.3.0'