From: Tomek Mrugalski Date: Thu, 15 Aug 2019 14:14:21 +0000 (+0200) Subject: [#721,!480] Documentation updated. X-Git-Tag: Kea-1.6.0~41^2~79 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d0d6581ab704683f35526b27200cfc9796898e0f;p=thirdparty%2Fkea.git [#721,!480] Documentation updated. --- diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index 6a5486e2fd..9660637912 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -229,6 +229,15 @@ options. Some commonly used options are: Build the optional ``kea-shell`` tool (more in :ref:`kea-shell`). The default is to not build it. +--with-site-packages + Only useful when ``kea-shell`` is enabled. It causes the kea-shell + python packages to be installed in specified directory. This is + mostly useful for Debian related distros. While most systems store + python packages in ${prefix}/usr/lib/pythonX/site-packages, Debian + introduced separate directory for packages installed from DEB. Such + python packages are expected to be installed in + /usr/lib/python3/dist-packages. + --enable-perfdhcp Build the optional ``perfdhcp`` DHCP benchmarking tool. The default is to not build it. diff --git a/doc/sphinx/arm/shell.rst b/doc/sphinx/arm/shell.rst index 821bdc23d2..75ba6a543d 100644 --- a/doc/sphinx/arm/shell.rst +++ b/doc/sphinx/arm/shell.rst @@ -109,7 +109,8 @@ tested with Python 2.7 and various versions of Python 3, up to 3.5. Since not every Kea deployment uses this feature and there are deployments that do not have Python, the Kea shell is not enabled by default. To use it, specify ``--enable-shell`` when running "configure" -during the installation of Kea. +during the installation of Kea. When building on Debian systems, also +``--with-site-packages=...`` may be useful. The Kea shell is intended to serve more as a demonstration of the RESTful interface's capabilities (and, perhaps, an illustration for