From a4c53928632881d10ea98e40491659b5b9790e43 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Fri, 26 Jan 2018 14:44:58 -0500 Subject: [PATCH] doc: replace random @cite{RFC...} with :rfc:... Signed-off-by: Quentin Young --- doc/user/ospfd.rst | 8 ++++---- doc/user/rpki.rst | 2 +- doc/user/snmp.rst | 2 +- doc/user/vnc.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index 23aae50ecc..d1dfd529f9 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -5,7 +5,7 @@ OSPFv2 ****** @acronym{OSPF,Open Shortest Path First} version 2 is a routing protocol -which is described in @cite{RFC2328, OSPF Version 2}. OSPF is an +which is described in :rfc:`2328`. OSPF is an @acronym{IGP,Interior Gateway Protocol}. Compared with @acronym{RIP}, @acronym{OSPF} can provide scalable network support and faster convergence times. OSPF is widely used in large networks such as @@ -107,7 +107,7 @@ Command {no router ospf} {} .. index:: {OSPF Command} {no ospf rfc1583compatibility} {} {OSPF Command} {no ospf rfc1583compatibility} {} - @cite{RFC2328}, the sucessor to @cite{RFC1583}, suggests according + :rfc:`2328`, the sucessor to :rfc:`1583`, suggests according to section G.2 (changes) in section 16.4 a change to the path preference algorithm that prevents possible routing loops that were possible in the old version of OSPFv2. More specifically it demands @@ -196,7 +196,7 @@ Command {no router ospf} {} .. index:: {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} {OSPF Command} {no max-metric router-lsa [on-startup|on-shutdown|administrative]} {} - This enables @cite{RFC3137, OSPF Stub Router Advertisement} support, + This enables :rfc:`3137` support, where the OSPF process describes its transit links in its router-LSA as having infinite distance so that other routers will avoid calculating transit paths through the router while still being able to reach @@ -376,7 +376,7 @@ OSPF area .. index:: {OSPF Command} {no area <0-4294967295> shortcut} {} {OSPF Command} {no area <0-4294967295> shortcut} {} - Configure the area as Shortcut capable. See @cite{RFC3509}. This requires + Configure the area as Shortcut capable. See :rfc:`3509`. This requires that the 'abr-type' be set to 'shortcut'. .. index:: {OSPF Command} {area `a.b.c.d` stub} {} diff --git a/doc/user/rpki.rst b/doc/user/rpki.rst index bf99940e39..3a1b23a3b3 100644 --- a/doc/user/rpki.rst +++ b/doc/user/rpki.rst @@ -18,7 +18,7 @@ complexity. The RPKI/RTR protocol is defined in @cite{RFC6810, The Resource Public Key Infrastructure (RPKI) to Router Protocol}, and the validation scheme in -@cite{RFC6811, BGP Prefix Origin Validation}. The current version of Prefix +:rfc:`6811`. The current version of Prefix Origin Validation in FRR implements both RFCs. For a more detailed but still easy-to-read background, we suggest the diff --git a/doc/user/snmp.rst b/doc/user/snmp.rst index 5c7da0e00c..26775743fe 100644 --- a/doc/user/snmp.rst +++ b/doc/user/snmp.rst @@ -8,7 +8,7 @@ SNMP Support feature for collecting network information from router and/or host. FRR itself does not support SNMP agent (server daemon) functionality but is able to connect to a SNMP agent using the SMUX protocol -(@cite{RFC1227}) or the AgentX protocol (@cite{RFC2741}) and make the +(:rfc:`1227`) or the AgentX protocol (:rfc:`2741`) and make the routing protocol MIBs available through it. Note that SNMP Support needs to be enabled at compile-time and loaded as diff --git a/doc/user/vnc.rst b/doc/user/vnc.rst index 525e4b1ecf..012ee33c77 100644 --- a/doc/user/vnc.rst +++ b/doc/user/vnc.rst @@ -19,7 +19,7 @@ Ethernet/Layer 2 (L2) VNs are supported. BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN information between NVAs. BGP based IP VPN support is defined in -@cite{RFC4364, BGP/MPLS IP Virtual Private Networks (VPNs)}, and +:rfc:`4364`, and @cite{RFC4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for IPv6 VPN }. Both the Encapsulation Subsequent Address Family Identifier (SAFI) and the Tunnel Encapsulation Attribute, @cite{RFC5512, The BGP @@ -433,7 +433,7 @@ are used to override the route targets for an NVE's Ethernet registrations based on the Logical Network Identifier and label value. A Logical Network Identifier is used to uniquely identify a logical Ethernet segment and is conceptually similar to the Ethernet Segment -Identifier defined in @cite{RFC7432, BGP MPLS-Based Ethernet VPN}. Both +Identifier defined in :rfc:`7432`. Both the Logical Network Identifier and Label are passed to VNC via RFP prefix and address registration. -- 2.39.5