summaryrefslogtreecommitdiffstats
path: root/doc/developer
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@qlyoung.net>2023-09-28 17:45:49 +0200
committerQuentin Young <qlyoung@qlyoung.net>2023-09-28 17:53:11 +0200
commitd98bba1be2d426e6a6223641661cca92b02fb962 (patch)
tree5dba204fc44ffe0864c22dda9efca4aa4a685013 /doc/developer
parentdoc: fixup nbapi doc images (diff)
downloadfrr-d98bba1be2d426e6a6223641661cca92b02fb962.tar.xz
frr-d98bba1be2d426e6a6223641661cca92b02fb962.zip
doc: couple nbapi doc cleanups
* Fix block quote & rfc link * Fix note block re: libyang dependencies Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/northbound/architecture.rst37
1 files changed, 20 insertions, 17 deletions
diff --git a/doc/developer/northbound/architecture.rst b/doc/developer/northbound/architecture.rst
index 8a77ef528..e571971c7 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 <https://github.com/CESNET/libyang#build-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