diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/workflow.rst | 23 | ||||
| -rw-r--r-- | doc/manpages/frr-zebra.rst | 4 | ||||
| -rw-r--r-- | doc/user/installation.rst | 4 | ||||
| -rw-r--r-- | doc/user/ospfd.rst | 59 | ||||
| -rw-r--r-- | doc/user/pim.rst | 4 |
5 files changed, 82 insertions, 12 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index f345464a35..4183ac6480 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -779,13 +779,12 @@ necessary replacements. .. _style-exceptions: Exceptions -^^^^^^^^^^ +"""""""""" FRR project code comes from a variety of sources, so there are some stylistic exceptions in place. They are organized here by branch. -For ``master`` -"""""""""""""" +For ``master``: BSD coding style applies to: @@ -797,8 +796,7 @@ BSD coding style applies to: - Indents are 4 spaces - Function return types are on their own line -For ``stable/3.0`` and ``stable/2.0`` -""""""""""""""""""""""""""""""""""""" +For ``stable/3.0`` and ``stable/2.0``: GNU coding style apply to the following parts: @@ -816,6 +814,21 @@ BSD coding style applies to: - ``ldpd/`` + +Python Code +^^^^^^^^^^^ + +Format all Python code with `black <https://github.com/psf/black>`_. + +In a line:: + + python3 -m black <file.py> + +Run this on any Python files you modify before committing. + +FRR's Python code has been formatted with black version 19.10b. + + YANG ^^^^ diff --git a/doc/manpages/frr-zebra.rst b/doc/manpages/frr-zebra.rst index cfb368bf44..722b011ecd 100644 --- a/doc/manpages/frr-zebra.rst +++ b/doc/manpages/frr-zebra.rst @@ -25,10 +25,6 @@ OPTIONS available for the |DAEMON| command: Runs in batch mode, zebra parses its config and exits. -.. option:: -k, --keep_kernel - - On startup, don't delete self inserted routes. - .. option:: -s, --nl-bufsize <netlink-buffer-size> Set netlink receive buffer size. There are cases where zebra daemon can't handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" messages in zebra log, you are in trouble. diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 0fd33eace8..ee06578b7c 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -380,6 +380,10 @@ options to the configuration script. Look for YANG modules in `dir` [`prefix`/share/yang]. Note that the FRR YANG modules will be installed here. +.. option:: --with-vici-socket <path> + + Set StrongSWAN vici interface socket path [/var/run/charon.vici]. + Python dependency, documentation and tests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 010526b637..b66774ca0e 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -853,6 +853,50 @@ Redistribution .. index:: no router zebra .. clicmd:: no router zebra +Graceful Restart Helper +======================= + +.. index:: graceful-restart helper-only [A.B.C.D] +.. clicmd:: graceful-restart helper-only [A.B.C.D] + +.. index:: no graceful-restart helper-only [A.B.C.D] +.. clicmd:: no graceful-restart helper-only [A.B.C.D] + + Configure Graceful Restart (RFC 3623) helper support. + By default, helper support is disabled for all neighbours. + This config enables/disables helper support on this router + for all neighbours. + To enable/disable helper support for a specific + neighbour, the router-id (A.B.C.D) has to be specified. + +.. index:: graceful-restart helper strict-lsa-checking +.. clicmd:: graceful-restart helper strict-lsa-checking + +.. index:: no graceful-restart helper strict-lsa-checking +.. clicmd:: no graceful-restart helper strict-lsa-checking + + If 'strict-lsa-checking' is configured then the helper will + abort the Graceful Restart when a LSA change occurs which + affects the restarting router. + By default 'strict-lsa-checking' is enabled" + +.. index:: graceful-restart helper supported-grace-time +.. clicmd:: graceful-restart helper supported-grace-time + +.. index:: no graceful-restart helper supported-grace-time +.. clicmd:: no graceful-restart helper supported-grace-time + + Supports as HELPER for configured grace period. + +.. index:: graceful-restart helper planned-only +.. clicmd:: graceful-restart helper planned-only + +.. index:: no graceful-restart helper planned-only +.. clicmd:: no graceful-restart helper planned-only + + It helps to support as HELPER only for planned + restarts. By default, it supports both planned and + unplanned outages. .. _showing-ospf-information: @@ -918,6 +962,12 @@ Showing Information Show the OSPF routing table, as determined by the most recent SPF calculation. +.. index:: show ip ospf graceful-restart helper [detail] [json] +.. clicmd:: show ip ospf graceful-restart helper [detail] [json] + + Displays the Grcaeful Restart Helper details including helper + config changes. + .. _opaque-lsa: Opaque LSA @@ -1218,10 +1268,17 @@ Debugging OSPF Show debug information of ZEBRA API +.. index:: debug ospf graceful-restart helper +.. clicmd:: debug ospf graceful-restart helper + +.. index:: no debug ospf graceful-restart helper +.. clicmd:: no debug ospf graceful-restart helper + + Enable/disable debug information for OSPF Graceful Restart Helper + .. index:: show debugging ospf .. clicmd:: show debugging ospf - OSPF Configuration Examples =========================== diff --git a/doc/user/pim.rst b/doc/user/pim.rst index b33ca3f2f4..b0a90bfc48 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -337,10 +337,10 @@ caution. Most of the time this will not be necessary. Insert into the Multicast Rib Route A.B.C.D/M using the specified INTERFACE. The distance can be specified as well if desired. -.. _msdp-configuration +.. _msdp-configuration: Multicast Source Discovery Protocol (MSDP) Configuration -==================== +======================================================== .. index:: ip msdp mesh-group [WORD] member A.B.C.D .. clicmd:: ip msdp mesh-group [WORD] member A.B.C.D |
