From f805c84eafe0d5dc9da120300a1458dd10bdd26f Mon Sep 17 00:00:00 2001 From: Renato Westphal Date: Sat, 3 Nov 2018 15:27:33 -0200 Subject: [PATCH] doc: update libyang build instructions The --with-yangmodelsdir and --with-libyang-pluginsdir build-time options pertain to FRR so they shouldn't be placed along with the libyang build instructions. Move these instructions to where they belong to avoid confusion. Signed-off-by: Renato Westphal --- doc/developer/building-libyang.rst | 20 -------------------- doc/user/installation.rst | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/doc/developer/building-libyang.rst b/doc/developer/building-libyang.rst index 9757ad454e..005b6ba786 100644 --- a/doc/developer/building-libyang.rst +++ b/doc/developer/building-libyang.rst @@ -40,23 +40,3 @@ When building libyang on CentOS 6, it's also necessary to pass the Note: please check the `libyang build requirements `_ first. - -Libyang uses loadable libraries an YANG modules. It supports -environment variables to allow overriding the load paths for each of -these. With FRR, this override currently must be done at the time of -running FRR's configure command using new options. The new options are: - -.. code-block:: shell - - --with-yangmodelsdir=DIR - yang models directory (${datarootdir}/yang) - --with-libyang-pluginsdir=DIR - yangmodule plugins directory - (${libdir}/frr/libyang_plugins) - -an example which uses the compile directory is: - -.. code-block:: shell - - ./configure --with-libyang-pluginsdir="`pwd`/yang/libyang_plugins/.libs" \ - --with-yangmodelsdir="`pwd`/yang" diff --git a/doc/user/installation.rst b/doc/user/installation.rst index b7f0712a1b..0a8cef53e1 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -255,6 +255,24 @@ options to the configuration script. Configure zebra to use `dir` for local state files, such as pid files and unix sockets. +.. option:: --with-yangmodelsdir + + Look for YANG modules in `dir` [`prefix`/share/yang]. Note that the FRR + YANG modules will be installed here. + +.. option:: --with-libyang-pluginsdir + + Look for libyang plugins in `dir` [`prefix`/lib/frr/libyang_plugins]. + Note that the FRR libyang plugins will be installed here. + +When it's desired to run FRR without installing it in the system, it's possible +to configure it as follows to look for YANG modules and libyang plugins in the +compile directory: +.. code-block:: shell + + ./configure --with-libyang-pluginsdir="`pwd`/yang/libyang_plugins/.libs" \ + --with-yangmodelsdir="`pwd`/yang" + .. _least-privilege-support: Least-Privilege Support -- 2.39.5