Skip to content

Commit

Permalink
doc: couple nbapi doc cleanups
Browse files Browse the repository at this point in the history
* Fix block quote & rfc link
* Fix note block re: libyang dependencies

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
  • Loading branch information
qlyoung committed Sep 28, 2023
1 parent 011d411 commit d98bba1
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions doc/developer/northbound/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d98bba1

Please sign in to comment.