summaryrefslogtreecommitdiff
path: root/doc/user/installation.rst
diff options
context:
space:
mode:
authorDavid Lamparter <equinox@diac24.net>2019-05-28 00:35:24 +0200
committerDavid Lamparter <equinox@diac24.net>2019-06-04 16:21:20 +0200
commit45da32d7a417ea639a092029c37c7fcc3bbc7813 (patch)
treef96076c9681b2ea54131bde54831d164711de194 /doc/user/installation.rst
parentb2eea7a00eb2fcc01dbcb0335546ac7d4224d11a (diff)
build: refactor & revamp python autoconf logic
Signed-off-by: David Lamparter <equinox@diac24.net>
Diffstat (limited to 'doc/user/installation.rst')
-rw-r--r--doc/user/installation.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/user/installation.rst b/doc/user/installation.rst
index 964297292f..6438c11413 100644
--- a/doc/user/installation.rst
+++ b/doc/user/installation.rst
@@ -347,6 +347,27 @@ compile directory:
./configure --with-libyang-pluginsdir="`pwd`/yang/libyang_plugins/.libs" \
--with-yangmodelsdir="`pwd`/yang"
+Python dependency, documentation and tests
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+FRR's documentation and basic unit tests heavily use code written in Python.
+Additionally, FRR ships Python extensions written in C which are used during
+its build process.
+
+To this extent, FRR needs the following:
+
+* an installation of CPython, preferably version 3.2 or newer (2.7 works but
+ is end of life and will stop working at some point.)
+* development files (mostly headers) for that version of CPython
+* an installation of `sphinx` for that version of CPython, to build the
+ documentation
+* an installation of `pytest` for that version of CPython, to run the unit
+ tests
+
+The `sphinx` and `pytest` dependencies can be avoided by not building
+documentation / not running ``make check``, but the CPython dependency is a
+hard dependency of the FRR build process (for the `clippy` tool.)
+
.. _least-privilege-support:
Least-Privilege Support