diff options
Diffstat (limited to 'doc/developer')
| -rw-r--r-- | doc/developer/building-libyang.rst | 22 | ||||
| -rw-r--r-- | doc/developer/topotests.rst | 12 | ||||
| -rw-r--r-- | doc/developer/workflow.rst | 1 |
3 files changed, 14 insertions, 21 deletions
diff --git a/doc/developer/building-libyang.rst b/doc/developer/building-libyang.rst index 5f82447d74..3b33eb3879 100644 --- a/doc/developer/building-libyang.rst +++ b/doc/developer/building-libyang.rst @@ -10,11 +10,12 @@ The FRR project builds some binary ``libyang`` packages. RPM packages are at our `RPM repository <https://rpm.frrouting.org>`_. DEB packages are available as CI artifacts `here -<https://ci1.netdef.org/browse/LIBYANG-LY1REL-DEB10AMD64-4/artifact>`_. +<https://ci1.netdef.org/browse/LIBYANG-LIBYANGV2/latestSuccessful/artifact>`_. .. warning:: - ``libyang`` version 1.0.184 or newer is required to build FRR. + ``libyang`` version 2.0.0 or newer is required to build FRR. Currently a tag + (``v2.0.0``) is used from the libyang2 branch. .. note:: @@ -26,31 +27,22 @@ DEB packages are available as CI artifacts `here Depending on your platform, you may also need to install the PCRE development package. Typically this is ``libpcre-dev`` or ``pcre-devel``. -.. note:: - - For Debian-based systems, the official ``libyang`` package requires recent - versions of ``swig`` (3.0.12) and ``debhelper`` (11) which are only - available in Debian buster (10). However, ``libyang`` packages built on - Debian buster can be installed on both Debian jessie (8) and Debian stretch - (9), as well as various Ubuntu systems. The ``python3-yang`` package will - not work, but the other packages (``libyang-dev`` is the one needed for FRR) - will. - **Option 2: Source Install** .. note:: Ensure that the `libyang build requirements - <https://github.com/CESNET/libyang/blob/master/README.md#build-requirements>`_ + <https://github.com/CESNET/libyang/tree/libyang2#build-requirements>`_ are met before continuing. Usually this entails installing ``cmake`` and ``libpcre-dev`` or ``pcre-devel``. .. code-block:: console - git clone https://github.com/CESNET/libyang.git + git clone https://github.com/CESNET/libyang.git -b libyang2 cd libyang + git checkout v2.0.0 mkdir build; cd build - cmake -DENABLE_LYD_PRIV=ON -DCMAKE_INSTALL_PREFIX:PATH=/usr \ + cmake -D CMAKE_INSTALL_PREFIX:PATH=/usr \ -D CMAKE_BUILD_TYPE:String="Release" .. make sudo make install diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index a86566dbb0..dd797a6949 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -59,7 +59,7 @@ there are some errors in the upstream MIBS which need to be patched up. The following steps will get you there on Ubuntu 20.04. .. code:: shell - + apt install libsnmp-dev apt install snmpd snmp apt install snmp-mibs-downloader @@ -68,9 +68,9 @@ following steps will get you there on Ubuntu 20.04. wget http://pastebin.com/raw.php?i=p3QyuXzZ -O /usr/share/snmp/mibs/ietf/SNMPv2-PDU wget http://pastebin.com/raw.php?i=gG7j8nyk -O /usr/share/snmp/mibs/ietf/IPATM-IPMC-MIB edit /etc/snmp/snmp.conf to look like this - # As the snmp packages come without MIB files due to license reasons, loading - # of MIBs is disabled by default. If you added the MIBs you can reenable - # loading them by commenting out the following line. + # As the snmp packages come without MIB files due to license reasons, loading + # of MIBs is disabled by default. If you added the MIBs you can reenable + # loading them by commenting out the following line. mibs +ALL @@ -485,7 +485,7 @@ Some things to keep in mind: in BGP, the test should look for the peers reconverging instead of just sleeping an arbitrary amount of time and continuing on. It is ok to use sleep in a tight loop with appropriate show commands to ensure that - the protocol reaches the desired state. This should be bounded by + the protocol reaches the desired state. This should be bounded by appropriate timeouts for the protocol in question though. See verify_bgp_convergence as a good example of this. If you are having troubles figuring out what to look for, please do not be afraid to ask. @@ -882,6 +882,8 @@ Example: Requirements: +- Directory name for a new topotest must not contain hyphen (``-``) characters. + To separate words, use underscores (``_``). For example, `tests/topotests/bgp_new_example`. - Test code should always be declared inside functions that begin with the ``test_`` prefix. Functions beginning with different prefixes will not be run by pytest. diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index b4ddec10c9..58b9c36e01 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -1247,7 +1247,6 @@ the command :clicmd:`show pony` would be documented as follows: .. code-block:: rest - .. index:: show pony .. clicmd:: show pony Prints an ASCII pony. Example output::: |