From: Quentin Young Date: Thu, 28 Sep 2023 15:45:49 +0000 (-0400) Subject: doc: couple nbapi doc cleanups X-Git-Tag: base_9.1~21^2~2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=d98bba1be2d426e6a6223641661cca92b02fb962;p=matthieu%2Ffrr.git doc: couple nbapi doc cleanups * Fix block quote & rfc link * Fix note block re: libyang dependencies Signed-off-by: Quentin Young --- diff --git a/doc/developer/northbound/architecture.rst b/doc/developer/northbound/architecture.rst index 8a77ef528f..e571971c7f 100644 --- a/doc/developer/northbound/architecture.rst +++ b/doc/developer/northbound/architecture.rst @@ -24,13 +24,14 @@ configuration changes regardless of where they came from. This model-driven design ensures feature parity across all management interfaces supported by FRR. -Quoting RFC 7950: > YANG is a language originally designed to model data -for the NETCONF protocol. A YANG module defines hierarchies of data that -can be used for NETCONF-based operations, including configuration, state -data, RPCs, and notifications. This allows a complete description of all -data sent between a NETCONF client and server. Although out of scope for -this specification, YANG can also be used with protocols other than -NETCONF. +Quoting :rfc:`7950`: + + YANG is a language originally designed to model data for the NETCONF + protocol. A YANG module defines hierarchies of data that can be used for + NETCONF-based operations, including configuration, state data, RPCs, and + notifications. This allows a complete description of all data sent between a + NETCONF client and server. Although out of scope for this specification, + YANG can also be used with protocols other than NETCONF. While the YANG and NETCONF specifications are tightly coupled with one another, both are independent to a certain extent and are evolving @@ -238,21 +239,23 @@ The new northbound adds the libyang library as a new mandatory dependency for FRR. To obtain and install this library, follow the steps below: -:: +.. code-block:: console + + git clone https://github.com/CESNET/libyang + cd libyang + git checkout devel + mkdir build ; cd build + cmake -DENABLE_LYD_PRIV=ON .. + make + sudo make install - $ git clone https://github.com/CESNET/libyang - $ cd libyang - $ git checkout devel - $ mkdir build ; cd build - $ cmake -DENABLE_LYD_PRIV=ON .. - $ make - $ sudo make install -.. +.. note:: - NOTE: first make sure to install the libyang + first make sure to install the libyang `requirements `__. + FRR needs libyang from version 0.16.7 or newer, which is maintained in the ``devel`` branch. libyang 0.15.x is maintained in the ``master`` branch and doesn’t contain one small feature used by FRR (the