From: Christian Hopps <chopps@labn.net>
Date: Wed, 17 May 2023 17:51:30 +0000 (-0400)
Subject: doc: document optionally required packages
X-Git-Tag: base_9.0~62^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=9b18d3d6ac4cd4d2f434693fbbab35c8b55f80a6;p=matthieu%2Ffrr.git

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>
---

diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index 7b1fde7b53..f44cf9df98 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'