]> git.proxmox.com Git - mirror_frr.git/commitdiff
doc: remove last bits of texinfo directives
authorQuentin Young <qlyoung@cumulusnetworks.com>
Wed, 31 Jan 2018 21:55:12 +0000 (16:55 -0500)
committerQuentin Young <qlyoung@cumulusnetworks.com>
Wed, 31 Jan 2018 22:27:07 +0000 (17:27 -0500)
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
doc/user/bgp.rst
doc/user/defines.rst [deleted file]
doc/user/vnc.rst

index a29f22bbdead03112d729cfb86da38a8a6cde116..a4c141fd32cf0168c5a2d834d740a748b42c47ec 100644 (file)
@@ -279,16 +279,7 @@ and sometimes not, depending on the properties of those other routes, means MED
 can cause the order of preference over all the routes to be undefined. That is,
 given routes A, B, and C, if A is preferred to B, and B is preferred to C, then
 a well-defined order should mean the preference is transitive (in the sense of
-orders @footnote{For some set of objects to have an order, there *must* be some
-binary ordering relation that is defined for *every* combination of those
-objects, and that relation *must* be transitive. I.e.@:, if the relation
-operator is <, and if a < b and b < c then that relation
-must carry over and it *must* be that a < c for the objects to have an
-order. The ordering relation may allow for equality, i.e.  a < b and b
-< a may both be true amd imply that a and b are equal in the order and
-not distinguished by it, in which case the set has a partial order. Otherwise,
-if there is an order, all the objects have a distinct place in the order and
-the set has a total order) and that A would be preferred to C.
+orders [#med-transitivity-rant])_ and that A would be preferred to C.
 
 However, when MED is involved this need not be the case. With MED it is
 possible that C is actually preferred over A. So A is preferred to B, B is
@@ -432,7 +423,7 @@ complex, non-full-mesh, iBGP topologies may be avoided either by:
 - Setting :ref:`bgp_always-compare-med`, however this allows MED to be compared
   across values set by different neighbour ASes, which may not produce
   coherent desirable results, of itself.
-- Effectively ignoring MED by setting MED to the same value (e.g.@: 0) using
+- Effectively ignoring MED by setting MED to the same value (e.g.: 0) using
   :ref:`routemap_set_metric` on all received routes, in combination with
   setting :ref:`bgp_always-compare-med` on all speakers. This is the simplest
   and most performant way to avoid MED oscillation issues, where an AS is happy
@@ -1667,39 +1658,36 @@ Other BGP commands
 Capability Negotiation
 ======================
 
-When adding IPv6 routing information exchange feature to BGP. There
-were some proposals. :abbr:`IETF (Internet Engineering Task Force)`
-:abbr:`IDR ( Inter Domain Routing)` :abbr:`IDR ( Inter Domain Routing)` adopted
-a proposal called Multiprotocol Extension for BGP. The specification
-is described in :rfc:`2283`. The protocol does not define new protocols.
-It defines new attributes to existing BGP. When it is used exchanging
-IPv6 routing information it is called BGP-4+. When it is used for
-exchanging multicast routing information it is called MBGP.
-
-*bgpd* supports Multiprotocol Extension for BGP. So if remote
-peer supports the protocol, *bgpd* can exchange IPv6 and/or
-multicast routing information.
-
-Traditional BGP did not have the feature to detect remote peer's
-capabilities, e.g. whether it can handle prefix types other than IPv4
-unicast routes. This was a big problem using Multiprotocol Extension
-for BGP to operational network. @cite{RFC2842, Capabilities
-Advertisement with BGP-4} adopted a feature called Capability
-Negotiation. *bgpd* use this Capability Negotiation to detect
-the remote peer's capabilities. If the peer is only configured as IPv4
-unicast neighbor, *bgpd* does not send these Capability
-Negotiation packets (at least not unless other optional BGP features
-require capability negotation).
-
-By default, FRR will bring up peering with minimal common capability
-for the both sides. For example, local router has unicast and
-multicast capabilitie and remote router has unicast capability. In
-this case, the local router will establish the connection with unicast
-only capability. When there are no common capabilities, FRR sends
-Unsupported Capability error and then resets the connection.
-
-If you want to completely match capabilities with remote peer. Please
-use *strict-capability-match* command.
+When adding IPv6 routing information exchange feature to BGP. There were some
+proposals. :abbr:`IETF (Internet Engineering Task Force)` :abbr:`IDR ( Inter
+Domain Routing)` :abbr:`IDR ( Inter Domain Routing)` adopted a proposal called
+Multiprotocol Extension for BGP. The specification is described in :rfc:`2283`.
+The protocol does not define new protocols. It defines new attributes to
+existing BGP. When it is used exchanging IPv6 routing information it is called
+BGP-4+. When it is used for exchanging multicast routing information it is
+called MBGP.
+
+*bgpd* supports Multiprotocol Extension for BGP. So if remote peer supports the
+protocol, *bgpd* can exchange IPv6 and/or multicast routing information.
+
+Traditional BGP did not have the feature to detect remote peer's capabilities,
+e.g. whether it can handle prefix types other than IPv4 unicast routes. This
+was a big problem using Multiprotocol Extension for BGP to operational network.
+:rfc:`2842` adopted a feature called Capability Negotiation. *bgpd* use this
+Capability Negotiation to detect the remote peer's capabilities. If the peer is
+only configured as IPv4 unicast neighbor, *bgpd* does not send these Capability
+Negotiation packets (at least not unless other optional BGP features require
+capability negotation).
+
+By default, FRR will bring up peering with minimal common capability for the
+both sides. For example, local router has unicast and multicast capabilitie and
+remote router has unicast capability. In this case, the local router will
+establish the connection with unicast only capability. When there are no common
+capabilities, FRR sends Unsupported Capability error and then resets the
+connection.
+
+If you want to completely match capabilities with remote peer. Please use
+*strict-capability-match* command.
 
 .. index:: neighbor PEER strict-capability-match
 .. clicmd:: neighbor PEER strict-capability-match
@@ -2330,6 +2318,7 @@ Server.
 .. include:: rpki.rst
 
 
+.. [#med-transitivity-rant] For some set of objects to have an order, there *must* be some binary ordering relation that is defined for *every* combination of those objects, and that relation *must* be transitive. I.e.:, if the relation operator is <, and if a < b and b < c then that relation must carry over and it *must* be that a < c for the objects to have an order. The ordering relation may allow for equality, i.e. a < b and b < a may both be true amd imply that a and b are equal in the order and not distinguished by it, in which case the set has a partial order. Otherwise, if there is an order, all the objects have a distinct place in the order and the set has a total order)
 .. [bgp-route-osci-cond] McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation Condition", IETF RFC3345
 .. [stable-flexible-ibgp] Flavel, A. and M. Roughan, "Stable and flexible iBGP", ACM SIGCOMM 2009
 .. [ibgp-correctness] Griffin, T. and G. Wilfong, "On the correctness of IBGP configuration", ACM SIGCOMM 2002
diff --git a/doc/user/defines.rst b/doc/user/defines.rst
deleted file mode 100644 (file)
index 69766d3..0000000
+++ /dev/null
@@ -1,24 +0,0 @@
-.. These are substitutions that were used in the original Texinfo docs.
-   They need to be recreated in RST by way of rst_prolog or a common include.
-   That, in turn, needs to be generated by make at compile time.
-   @c -*- texinfo -*-
-   @c doc/defines.texi.  Generated from defines.texi.in by configure.
-
-   @c Set variables
-   @set PACKAGE_NAME frr
-   @set PACKAGE_TARNAME frr
-   @set PACKAGE_STRING frr 3.1-dev
-   @set PACKAGE_URL https://frrouting.org/
-   @set PACKAGE_VERSION 3.1-dev
-   @set AUTHORS Kunihiro Ishiguro, et al.
-   @set COPYRIGHT_YEAR 1999-2005
-   @set COPYRIGHT_STR Copyright @copyright{} |COPYRIGHT_YEAR| |AUTHORS|
-
-   @c These may vary with installation environment.
-   @set INSTALL_PREFIX_ETC /etc/frr
-   @set INSTALL_PREFIX_SBIN /usr/lib/frr
-   @set INSTALL_PREFIX_STATE /var/run/frr
-   @set INSTALL_PREFIX_MODULES /usr/lib/frr/modules
-   @set INSTALL_USER frr
-   @set INSTALL_GROUP frr
-   @set INSTALL_VTY_GROUP frrvty
index bd2fdb34f16519c5810776e75b34aec1db68c8f3..62091822b9ced1622aace85e96a2221597f65a90 100644 (file)
@@ -909,11 +909,10 @@ services to three NVE clients in the 172.16.0.0/16 virtual-network address
 range. The 172.16.0.0/16 address range is partitioned into two NVE groups,
 ``group1`` (172.16.0.0/17) and ``group2`` (172.16.128.0/17).
 
-Each NVE belongs to either NVE group ``group1`` or NVE group
-``group2``.  The NVEs ``NVE 1``, ``NVE 2``, @code{NVE
-4}, ``NVE 7``, and ``NVE 8`` are members of the NVE group
-``group1``.  The NVEs ``NVE 3``, ``NVE 5``, @code{NVE
-6}, and ``NVE 9`` are members of the NVE group ``group2``.
+Each NVE belongs to either NVE group ``group1`` or NVE group ``group2``.  The
+NVEs ``NVE 1``, ``NVE 2``, ``NVE 4``, ``NVE 7``, and ``NVE 8`` are members of
+the NVE group ``group1``.  The NVEs ``NVE 3``, ``NVE 5``, ``NVE 6``, and ``NVE
+9`` are members of the NVE group ``group2``.
 
 Each NVA advertises NVE underlay-network IP addresses using the
 Tunnel Encapsulation Attribute.
@@ -1134,10 +1133,6 @@ as the hub between NVAs. :ref:`vnc-fig-vnc-frr-route-reflector` shows BGP
 route reflector ``BGP Route Reflector 1`` (192.168.1.100) as a route reflector
 for NVAs ``NVA 2``(192.168.1.101) and ``NVA 3`` (192.168.1.102).
 
-@float Figure,fig:fig-vnc-frr-route-reflector @center
-@image{fig-vnc-frr-route-reflector,400pt,,Frr Route Reflector} @caption{Two
-NVAs and a BGP Route Reflector} @end float
-
 .. _vnc-fig-vnc-frr-route-reflector:
 .. figure:: ../figures/fig-vnc-frr-route-reflector.png
    :align: center