Update the doc regarding the BFD settings.

scionproto · Mar 27, 2024 · ac6c66b · ac6c66b
1 parent 14aa7ff
commit ac6c66b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 19 deletions.
diff --git a/doc/manuals/common.rst b/doc/manuals/common.rst
@@ -292,39 +292,31 @@ of the individual fields below.
          instance with :option:`general.id <router-conf-toml general.id>` matching
          :option:`<router-id> <topology-json <router-id>>`.
 
-         .. option:: disable = <bool>, default false
+         .. option:: disable = <bool>, default :option:`router.bfd.disabled <router-conf-toml disabled>`
 
             Disable BFD, unconditionally consider the connection alive.
 
-            If true, takes precedence over :option:`router.bfd.disabled <router-conf-toml disabled>`.
-
-         .. option:: detect_mult = <uint8>, default 3
+         .. option:: detect_mult = <uint8>, default :option:`router.bfd.disabled <router-conf-toml detect_mult>`
 
             After ``detect_mult`` consecutively missing control packets, the BFD session is
             considered "down" and is reset.
 
-            Takes precedence over :option:`router.bfd.disabled <router-conf-toml detect_mult>`.
-
-         .. option:: desired_min_tx_interval = <duration>, default 200ms
+         .. option:: desired_min_tx_interval = <duration>, default :option:`router.bfd.disired_min_tx_interval <router-conf-toml desired_min_tx_interval>`.
 
             Defines the frequency at which this router should send BFD control messages for this
             inter-domain link.
             The effective interval is the result of negotiating with the remote router during
             session establishment;
             the value will be ``max(desired_min_tx_interval, remote.required_min_rx_interval)``.
 
-            Takes precedence over :option:`router.bfd.disired_min_tx_interval <router-conf-toml desired_min_tx_interval>`.
-
-         .. option:: required_min_rx_interval = <duration>, default 200ms
+         .. option:: required_min_rx_interval = <duration>, default :option:`router.bfd.required_min_rx_interval <router-conf-toml required_min_rx_interval>`
 
             Defines an upper bound for the frequency at which this router wants to receive BFD
             control messages for this inter-domain link.
             The effective interval at which the remote router will send control messages is the
             result of negotiating with the remote router during session establishment;
             the value will be ``max(remote.desired_min_tx_interval, required_min_rx_interval)``.
 
-            Takes precedence over :option:`router.bfd.required_min_rx_interval <router-conf-toml required_min_rx_interval>`.
-
 .. option:: control_service
 
    .. option:: <cs-id>

diff --git a/doc/manuals/router.rst b/doc/manuals/router.rst
@@ -173,8 +173,8 @@ considers the following options.
 
    .. option:: router.num_slow_processors = <int> (Default: 1)
 
-      Number of goroutines started for the slow-path processing which includes all SCMP traffic and traceroutes.
-      A minimum of 1 slow-path processor is required.
+      Number of goroutines started for the slow-path processing which includes all SCMP traffic and
+      traceroutes. A minimum of 1 slow-path processor is required.
 
    .. option:: router.batch_size = <int> (Default: 256)
 
@@ -185,13 +185,14 @@ considers the following options.
 
       .. option:: disabled = <bool> (Default: false)
 
-         Whether the :term:`BFD` feature is disabled globally. If disabled, the router
-         unconditionally considers any connection alive.
+         Set whether the :term:`BFD` feature is disabled by default.
 
-         Applies to BFD sessions to all neighboring routers, including sibling routers (other
-         routers in the same AS). When not globally disabled, :term:`BFD` can be disabled for
-         specific inter-AS BFD sessions with :option:`bfd.disable <topology-json disable>`.
+         This setting applies to BFD sessions to all neighboring routers, including sibling routers
+         (other routers in the same AS).
 
+         Can be overridden for specific inter-AS BFD
+         sessions with :option:`bfd.disable <topology-json disable>`.
+
       .. option:: detect_mult = <uint8>, default 3
 
          Set the :term:`BFD` detection time multiplier.