]> git.puffer.fish Git - matthieu/frr.git/commitdiff
doc: couple nbapi doc cleanups
authorQuentin Young <qlyoung@qlyoung.net>
Thu, 28 Sep 2023 15:45:49 +0000 (11:45 -0400)
committerQuentin Young <qlyoung@qlyoung.net>
Thu, 28 Sep 2023 15:53:11 +0000 (11:53 -0400)
* Fix block quote & rfc link
* Fix note block re: libyang dependencies

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
doc/developer/northbound/architecture.rst

index 8a77ef528f5ed4f583482dcc4058267947e1151c..e571971c7f53789ec580999846812effcf25d598 100644 (file)
@@ -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