Re: bgpd.conf.5: Tag groups
On Sun, Feb 16, 2020 at 09:47:43PM +0100, Ingo Schwarze wrote: > Sure. I'm not convinced you even need OKs for such simple tagging > corrections. > > By the way, just > > .Tg > .Ic neighbor > > .Tg > .Ic group > > is sufficient, the .Tg macro defaults to the first argument of the first > macro on the following line, if any. That's why I didn't commit without feedback. I'm a) new to BGP and b) wasn't sure whether that markup was 100% correct. Thanks.
Re: bgpd.conf.5: Tag groups
Hi Klemens,
Klemens Nanni wrote on Sun, Feb 16, 2020 at 09:32:52PM +0100:
> On Sun, Feb 16, 2020 at 09:25:51PM +0100, Klemens Nanni wrote:
>> Going through the example with bgpd.conf(5) side by side, jumping to the
>> "group" tag shows
>>
>> group descr Neighbors in this group will be matched.
>> AS as-number
>> Neighbors with this AS will be matched.
>> ...
>>
>> which is somewhere in the manual that assumes knowing what groups are.
>> mdoc's automatic tagging failed here, so markup `Ic group' in proper
>> section:
>>
>> NEIGHBORS AND GROUPS
>> bgpd(8) establishes TCP connections to other BGP speakers called
>> neighbors. A neighbor and its properties are specified by a
>> neighbor
>> section:
>>
>> neighbor 10.0.0.2 {
>> remote-as 65002
>> descr "a neighbor"
>> }
>>
>> Neighbors placed within a group section inherit the properties
>> common to
>> that group:
>> ...
>>
>> This makes typing ":tgroup" jump to that very last sentence.
> Same for `neighbor' in the very same section as well.
>
> OK?
Sure. I'm not convinced you even need OKs for such simple tagging
corrections.
By the way, just
.Tg
.Ic neighbor
.Tg
.Ic group
is sufficient, the .Tg macro defaults to the first argument of the first
macro on the following line, if any.
Yours,
Ingo
> Index: bgpd.conf.5
> ===
> RCS file: /cvs/src/usr.sbin/bgpd/bgpd.conf.5,v
> retrieving revision 1.200
> diff -u -p -r1.200 bgpd.conf.5
> --- bgpd.conf.5 9 Feb 2020 14:21:26 - 1.200
> +++ bgpd.conf.5 16 Feb 2020 20:31:46 -
> @@ -683,6 +683,7 @@ can be chosen by the local operator.
> establishes TCP connections to other BGP speakers called
> .Em neighbors .
> A neighbor and its properties are specified by a
> +.Tg neighbor
> .Ic neighbor
> section:
> .Bd -literal -offset indent
> @@ -693,6 +694,7 @@ neighbor 10.0.0.2 {
> .Ed
> .Pp
> Neighbors placed within a
> +.Tg group
> .Ic group
> section inherit the properties common to that group:
> .Bd -literal -offset indent
Re: bgpd.conf.5: Tag groups
On Sun, Feb 16, 2020 at 09:25:51PM +0100, Klemens Nanni wrote:
> Going through the example with bgpd.conf(5) side by side, jumping to the
> "group" tag shows
>
> group descr Neighbors in this group will be matched.
> AS as-number
>Neighbors with this AS will be matched.
> ...
>
> which is somewhere in the manual that assumes knowing what groups are.
> mdoc's automatic tagging failed here, so markup `Ic group' in proper
> section:
>
> NEIGHBORS AND GROUPS
>bgpd(8) establishes TCP connections to other BGP speakers called
>neighbors. A neighbor and its properties are specified by a
> neighbor
>section:
>
>neighbor 10.0.0.2 {
>remote-as 65002
>descr "a neighbor"
>}
>
>Neighbors placed within a group section inherit the properties
> common to
>that group:
>...
>
> This makes typing ":tgroup" jump to that very last sentence.
Same for `neighbor' in the very same section as well.
OK?
Index: bgpd.conf.5
===
RCS file: /cvs/src/usr.sbin/bgpd/bgpd.conf.5,v
retrieving revision 1.200
diff -u -p -r1.200 bgpd.conf.5
--- bgpd.conf.5 9 Feb 2020 14:21:26 - 1.200
+++ bgpd.conf.5 16 Feb 2020 20:31:46 -
@@ -683,6 +683,7 @@ can be chosen by the local operator.
establishes TCP connections to other BGP speakers called
.Em neighbors .
A neighbor and its properties are specified by a
+.Tg neighbor
.Ic neighbor
section:
.Bd -literal -offset indent
@@ -693,6 +694,7 @@ neighbor 10.0.0.2 {
.Ed
.Pp
Neighbors placed within a
+.Tg group
.Ic group
section inherit the properties common to that group:
.Bd -literal -offset indent
bgpd.conf.5: Tag groups
Going through the example with bgpd.conf(5) side by side, jumping to the
"group" tag shows
group descr Neighbors in this group will be matched.
AS as-number
Neighbors with this AS will be matched.
...
which is somewhere in the manual that assumes knowing what groups are.
mdoc's automatic tagging failed here, so markup `Ic group' in proper
section:
NEIGHBORS AND GROUPS
bgpd(8) establishes TCP connections to other BGP speakers called
neighbors. A neighbor and its properties are specified by a
neighbor
section:
neighbor 10.0.0.2 {
remote-as 65002
descr "a neighbor"
}
Neighbors placed within a group section inherit the properties
common to
that group:
...
This makes typing ":tgroup" jump to that very last sentence.
Feedback? OK?
Index: bgpd.conf.5
===
RCS file: /cvs/src/usr.sbin/bgpd/bgpd.conf.5,v
retrieving revision 1.200
diff -u -p -r1.200 bgpd.conf.5
--- bgpd.conf.5 9 Feb 2020 14:21:26 - 1.200
+++ bgpd.conf.5 16 Feb 2020 20:15:50 -
@@ -693,6 +693,7 @@ neighbor 10.0.0.2 {
.Ed
.Pp
Neighbors placed within a
+.Tg group
.Ic group
section inherit the properties common to that group:
.Bd -literal -offset indent
