doc: move -r option docs to zebra only

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

diff --git a/doc/manpages/common-options.rst b/doc/manpages/common-options.rst
index e433c720afb71a7c1f3c9414dbfcfd242f6f68dc..e9241b743863c5b4e83d4af63257d5cd0122ee83 100644 (file)
--- a/doc/manpages/common-options.rst
+++ b/doc/manpages/common-options.rst
@@ -157,10 +157,3 @@ frr supports optional dynamically loadable modules, although these can only be l
 
 The list of loaded modules can be inspected at runtime with the show modules VTY command.
 
-ROUTES
-------
-
-.. option:: -r, --retain
-
-   When the program terminates, retain routes added by the daemon.
-

diff --git a/doc/manpages/zebra.rst b/doc/manpages/zebra.rst
index 4ddf9899513aac75ac26168fc98f1274d0ce8f7e..a8a9301588f1181eafc429cabf9c37d6f56e6fb2 100644 (file)
--- a/doc/manpages/zebra.rst
+++ b/doc/manpages/zebra.rst
@@ -42,6 +42,14 @@ OPTIONS available for the |DAEMON| command:
 
    Enable namespace VRF backend. By default, the VRF backend relies on VRF-lite support from the Linux kernel. This option permits discovering Linux named network namespaces and mapping it to FRR VRF contexts.
 
+ROUTES
+------
+
+.. option:: -r, --retain
+
+   When the program terminates, do not flush routes installed by zebra from the kernel.
+
+
 FILES
 =====
 

diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index 861e3d0d6df4e79f9a86ac5298b3a06bddba38f4..9332fdf3b7a172275259db7bd39420861b5c7324 100644 (file)
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -30,10 +30,6 @@ be specified (:ref:`common-invocation-options`).
    Set the bgp protocol's port number. When port number is 0, that means do not
    listen bgp port.
 
-.. option:: -r, --retain
-
-   When program terminates, retain BGP routes added by zebra.
-
 .. option:: -l, --listenon
 
    Specify a specific IP address for bgpd to listen on, rather than its

diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst
index 6034bf8948ab1cadb79f4b5faa0bf5f6f15f6dc0..330267a8ee83b0cb5fba513dc7e642ce221483a5 100644 (file)
--- a/doc/user/eigrpd.rst
+++ b/doc/user/eigrpd.rst
@@ -60,10 +60,6 @@ Certain signals have special meanings to *eigrpd*.
 
 .. program:: eigrpd
 
-.. option:: -r, --retain
-
-   When the program terminates, retain routes added by *eigrpd*.
-
 .. _eigrp-configuration:
 
 EIGRP Configuration

diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst
index 973e61949e0a2e73d0556340c48af526a40a43b9..372c30f58766468e5be3860fafd21daee548aab3 100644 (file)
--- a/doc/user/ripd.rst
+++ b/doc/user/ripd.rst
@@ -60,9 +60,6 @@ Certain signals have special meanings to *ripd*.
 *ripd* invocation options. Common options that can be specified
 (:ref:`common-invocation-options`).
 
-.. option:: -r, --retain
-
-   When the program terminates, retain routes added by *ripd*.
 
 .. _rip-netmask:
 

diff --git a/doc/user/setup.rst b/doc/user/setup.rst
index 9971c43c5e136d1afc84d1967408c6fb536cae04..1bbbe369317b6f96930c94822efdf8877e81045e 100644 (file)
--- a/doc/user/setup.rst
+++ b/doc/user/setup.rst
@@ -50,7 +50,7 @@ This file has several parts. Here is an example:
    # Check /etc/pam.d/frr if you intend to use "vtysh"!
    #
    vtysh_enable=yes
-   zebra_options=" -r -s 90000000 --daemon -A 127.0.0.1"
+   zebra_options=" -s 90000000 --daemon -A 127.0.0.1"
    bgpd_options="   --daemon -A 127.0.0.1"
    ospfd_options="  --daemon -A 127.0.0.1"
    ospf6d_options=" --daemon -A ::1"
@@ -86,7 +86,7 @@ reasons touched on in the VTYSH documentation and should generally be enabled.
 
 ::
 
-   zebra_options=" -r -s 90000000 --daemon -A 127.0.0.1"
+   zebra_options=" -s 90000000 --daemon -A 127.0.0.1"
    bgpd_options="   --daemon -A 127.0.0.1"
    ...
 

diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index a2cf3627ac2da3b9372ef0f71b5d74f0dd887e6c..9e377330ee7bf60c742baff44688e6eee6b24a01 100644 (file)
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -29,7 +29,8 @@ Besides the common invocation options (:ref:`common-invocation-options`), the
 
 .. option:: -r, --retain
 
-   When program terminates, retain routes added by zebra.
+   When program terminates, do not flush routes installed by *zebra* from the
+   kernel.
 
 .. option:: -e X, --ecmp X