Jerry/bird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Doc: Remove some superfluous slashes

Browse source
This commit is contained in:
Ondrej Zajicek (work) 2018-03-24 01:53:03 +01:00
parent 6807320a0f
commit 157f6c2aad
1 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
doc/bird.sgml
View file

@ -2587,17 +2587,17 @@ be used in explicit configuration.
some of them (marked with `<tt/O/') are optional. some of them (marked with `<tt/O/') are optional.
<descrip> <descrip>
<tag><label id="rta-bgp-path">bgppath bgp_path/</tag> <tag><label id="rta-bgp-path">bgppath bgp_path</tag>
Sequence of AS numbers describing the AS path the packet will travel Sequence of AS numbers describing the AS path the packet will travel
through when forwarded according to the particular route. In case of through when forwarded according to the particular route. In case of
internal BGP it doesn't contain the number of the local AS. internal BGP it doesn't contain the number of the local AS.
<tag><label id="rta-bgp-local-pref">int bgp_local_pref/ [I]</tag> <tag><label id="rta-bgp-local-pref">int bgp_local_pref [I]</tag>
Local preference value used for selection among multiple BGP routes (see Local preference value used for selection among multiple BGP routes (see
the selection rules above). It's used as an additional metric which is the selection rules above). It's used as an additional metric which is
propagated through the whole local AS. propagated through the whole local AS.
<tag><label id="rta-bgp-med">int bgp_med/ [O]</tag> <tag><label id="rta-bgp-med">int bgp_med [O]</tag>
The Multiple Exit Discriminator of the route is an optional attribute The Multiple Exit Discriminator of the route is an optional attribute
which is used on external (inter-AS) links to convey to an adjacent AS which is used on external (inter-AS) links to convey to an adjacent AS
the optimal entry point into the local AS. The received attribute is the optimal entry point into the local AS. The received attribute is
@ -2608,20 +2608,20 @@ some of them (marked with `<tt/O/') are optional.
external BGP instance. See <rfc id="4451"> for further discussion of external BGP instance. See <rfc id="4451"> for further discussion of
BGP MED attribute. BGP MED attribute.
<tag><label id="rta-bgp-origin">enum bgp_origin/</tag> <tag><label id="rta-bgp-origin">enum bgp_origin</tag>
Origin of the route: either <cf/ORIGIN_IGP/ if the route has originated Origin of the route: either <cf/ORIGIN_IGP/ if the route has originated
in an interior routing protocol or <cf/ORIGIN_EGP/ if it's been imported in an interior routing protocol or <cf/ORIGIN_EGP/ if it's been imported
from the <tt>EGP</tt> protocol (nowadays it seems to be obsolete) or from the <tt>EGP</tt> protocol (nowadays it seems to be obsolete) or
<cf/ORIGIN_INCOMPLETE/ if the origin is unknown. <cf/ORIGIN_INCOMPLETE/ if the origin is unknown.
<tag><label id="rta-bgp-next-hop">ip bgp_next_hop/</tag> <tag><label id="rta-bgp-next-hop">ip bgp_next_hop</tag>
Next hop to be used for forwarding of packets to this destination. On Next hop to be used for forwarding of packets to this destination. On
internal BGP connections, it's an address of the originating router if internal BGP connections, it's an address of the originating router if
it's inside the local AS or a boundary router the packet will leave the it's inside the local AS or a boundary router the packet will leave the
AS through if it's an exterior route, so each BGP speaker within the AS AS through if it's an exterior route, so each BGP speaker within the AS
has a chance to use the shortest interior path possible to this point. has a chance to use the shortest interior path possible to this point.
<tag><label id="rta-bgp-atomic-aggr">void bgp_atomic_aggr/ [O]</tag> <tag><label id="rta-bgp-atomic-aggr">void bgp_atomic_aggr [O]</tag>
This is an optional attribute which carries no value, but the sole This is an optional attribute which carries no value, but the sole
presence of which indicates that the route has been aggregated from presence of which indicates that the route has been aggregated from
multiple routes by some router on the path from the originator. multiple routes by some router on the path from the originator.
@ -2629,7 +2629,7 @@ some of them (marked with `<tt/O/') are optional.
<!-- we don't handle aggregators right since they are of a very obscure type <!-- we don't handle aggregators right since they are of a very obscure type
<tag>bgp_aggregator</tag> <tag>bgp_aggregator</tag>
--> -->
<tag><label id="rta-bgp-community">clist bgp_community/ [O]</tag> <tag><label id="rta-bgp-community">clist bgp_community [O]</tag>
List of community values associated with the route. Each such value is a List of community values associated with the route. Each such value is a
pair (represented as a <cf/pair/ data type inside the filters) of 16-bit pair (represented as a <cf/pair/ data type inside the filters) of 16-bit
integers, the first of them containing the number of the AS which integers, the first of them containing the number of the AS which
@ -2640,14 +2640,14 @@ some of them (marked with `<tt/O/') are optional.
freedom about which community attributes it defines and what will their freedom about which community attributes it defines and what will their
semantics be. semantics be.
<tag><label id="rta-bgp-ext-community">eclist bgp_ext_community/ [O]</tag> <tag><label id="rta-bgp-ext-community">eclist bgp_ext_community [O]</tag>
List of extended community values associated with the route. Extended List of extended community values associated with the route. Extended
communities have similar usage as plain communities, but they have an communities have similar usage as plain communities, but they have an
extended range (to allow 4B ASNs) and a nontrivial structure with a type extended range (to allow 4B ASNs) and a nontrivial structure with a type
field. Individual community values are represented using an <cf/ec/ data field. Individual community values are represented using an <cf/ec/ data
type inside the filters. type inside the filters.
<tag><label id="rta-bgp-large-community">lclist <cf/bgp_large_community/ [O]</tag> <tag><label id="rta-bgp-large-community">lclist bgp_large_community [O]</tag>
List of large community values associated with the route. Large BGP List of large community values associated with the route. Large BGP
communities is another variant of communities, but contrary to extended communities is another variant of communities, but contrary to extended
communities they behave very much the same way as regular communities, communities they behave very much the same way as regular communities,
@ -2655,12 +2655,12 @@ some of them (marked with `<tt/O/') are optional.
Individual community values are represented using an <cf/lc/ data type Individual community values are represented using an <cf/lc/ data type
inside the filters. inside the filters.
<tag><label id="rta-bgp-originator-id">quad bgp_originator_id/ [I, O]</tag> <tag><label id="rta-bgp-originator-id">quad bgp_originator_id [I, O]</tag>
This attribute is created by the route reflector when reflecting the This attribute is created by the route reflector when reflecting the
route and contains the router ID of the originator of the route in the route and contains the router ID of the originator of the route in the
local AS. local AS.
<tag><label id="rta-bgp-cluster-list">clist bgp_cluster_list/ [I, O]</tag> <tag><label id="rta-bgp-cluster-list">clist bgp_cluster_list [I, O]</tag>
This attribute contains a list of cluster IDs of route reflectors. Each This attribute contains a list of cluster IDs of route reflectors. Each
route reflector prepends its cluster ID when reflecting the route. route reflector prepends its cluster ID when reflecting the route.
</descrip> </descrip>
@ -2922,26 +2922,26 @@ translated to appropriate system (and OS-specific) route attributes. We support
these attributes: these attributes:
<descrip> <descrip>
<tag><label id="rta-krt-source">int krt_source/</tag> <tag><label id="rta-krt-source">int krt_source</tag>
The original source of the imported kernel route. The value is The original source of the imported kernel route. The value is
system-dependent. On Linux, it is a value of the protocol field of the system-dependent. On Linux, it is a value of the protocol field of the
route. See /etc/iproute2/rt_protos for common values. On BSD, it is route. See /etc/iproute2/rt_protos for common values. On BSD, it is
based on STATIC and PROTOx flags. The attribute is read-only. based on STATIC and PROTOx flags. The attribute is read-only.
<tag><label id="rta-krt-metric">int krt_metric/</tag> (Linux) <tag><label id="rta-krt-metric">int krt_metric</tag> (Linux)
The kernel metric of the route. When multiple same routes are in a The kernel metric of the route. When multiple same routes are in a
kernel routing table, the Linux kernel chooses one with lower metric. kernel routing table, the Linux kernel chooses one with lower metric.
Note that preferred way to set kernel metric is to use protocol option Note that preferred way to set kernel metric is to use protocol option
<cf/metric/, unless per-route metric values are needed. <cf/metric/, unless per-route metric values are needed.
<tag><label id="rta-krt-prefsrc">ip krt_prefsrc/</tag> (Linux) <tag><label id="rta-krt-prefsrc">ip krt_prefsrc</tag> (Linux)
The preferred source address. Used in source address selection for The preferred source address. Used in source address selection for
outgoing packets. Has to be one of the IP addresses of the router. outgoing packets. Has to be one of the IP addresses of the router.
<tag><label id="rta-krt-realm">int krt_realm/</tag> (Linux) <tag><label id="rta-krt-realm">int krt_realm</tag> (Linux)
The realm of the route. Can be used for traffic classification. The realm of the route. Can be used for traffic classification.
<tag><label id="rta-krt-scope">int krt_scope/</tag> (Linux IPv4) <tag><label id="rta-krt-scope">int krt_scope</tag> (Linux IPv4)
The scope of the route. Valid values are 0-254, although Linux kernel The scope of the route. Valid values are 0-254, although Linux kernel
may reject some values depending on route type and nexthop. It is may reject some values depending on route type and nexthop. It is
supposed to represent `indirectness' of the route, where nexthops of supposed to represent `indirectness' of the route, where nexthops of
@ -3963,13 +3963,13 @@ definitions, prefix definitions and DNS definitions:
<p>RAdv defines two route attributes: <p>RAdv defines two route attributes:
<descrip> <descrip>
<tag><label id="rta-ra-preference">enum ra_preference/</tag> <tag><label id="rta-ra-preference">enum ra_preference</tag>
The preference of the route. The value can be <it/RA_PREF_LOW/, The preference of the route. The value can be <it/RA_PREF_LOW/,
<it/RA_PREF_MEDIUM/ or <it/RA_PREF_HIGH/. If the attribute is not set, <it/RA_PREF_MEDIUM/ or <it/RA_PREF_HIGH/. If the attribute is not set,
the <ref id="radv-iface-route-preference" name="route preference"> the <ref id="radv-iface-route-preference" name="route preference">
option is used. option is used.
<tag><label id="rta-ra-lifetime">int ra_lifetime/</tag> <tag><label id="rta-ra-lifetime">int ra_lifetime</tag>
The advertised lifetime of the route, in seconds. The special value of The advertised lifetime of the route, in seconds. The special value of
0xffffffff represents infinity. If the attribute is not set, the 0xffffffff represents infinity. If the attribute is not set, the
<ref id="radv-iface-route-lifetime" name="route lifetime"> <ref id="radv-iface-route-lifetime" name="route lifetime">
@ -4275,13 +4275,13 @@ protocol rip [ng] [&lt;name&gt;] {
<p>RIP defines two route attributes: <p>RIP defines two route attributes:
<descrip> <descrip>
<tag>int <cf/rip_metric/</tag> <tag><label id="rta-rip-metric">int rip_metric</tag>
RIP metric of the route (ranging from 0 to <cf/infinity/). When routes RIP metric of the route (ranging from 0 to <cf/infinity/). When routes
from different RIP instances are available and all of them have the same from different RIP instances are available and all of them have the same
preference, BIRD prefers the route with lowest <cf/rip_metric/. When a preference, BIRD prefers the route with lowest <cf/rip_metric/. When a
non-RIP route is exported to RIP, the default metric is 1. non-RIP route is exported to RIP, the default metric is 1.
<tag><label id="rta-rip-tag">int rip_tag/</tag> <tag><label id="rta-rip-tag">int rip_tag</tag>
RIP route tag: a 16-bit number which can be used to carry additional RIP route tag: a 16-bit number which can be used to carry additional
information with the route (for example, an originating AS number in information with the route (for example, an originating AS number in
case of external routes). When a non-RIP route is exported to RIP, the case of external routes). When a non-RIP route is exported to RIP, the