Re: Improve semantics and punctuation in ifconfig.8
On Sun, Aug 23, 2020 at 10:03:54PM +0100, Jason McIntyre wrote: > On Sat, Aug 22, 2020 at 02:18:48PM -0700, Evan Silberman wrote: > > Not to provoke a deep philosophical debate about the difference between > > Ql, Cm, and Sy, but surely Em isn't the best choice here. A couple other > > nits that bothered me in the same general region, I guess your taste > > might vary. > > > > Evan Silberman > > > > hi > > > --- > > commit 233b62ce4e6cd3388e68f407e50758111b3eeffc (ifconfig.8) > > from: Evan Silberman > > date: Sat Aug 22 21:14:25 2020 UTC > > > > Improve markup and punctuation concerning groups > > > > - They're groups, not scare-quotes-"groups" > > oddly enough, this usage is probably close to what Em is meant for ;) > quoting here is just another way to add that emphasis. but i agree it > doesn;t make the text more readable. > > > - The markup for the default groups is debatable, but Cm seems closest. > >You might also like: Ql, Sy > > i would prefer to use one macro rather than two. i agree Em is not > great. i would just use Dq. > > > - Parenthesized plural(s) is (are) distracting > > > > i heartily agree. > > so, if no one chips in soon, i will commit your diff, but with a > straight Em->Dq replacement. > > jmc > ...which i have just done. thanks for the diff, jmc
Re: Improve semantics and punctuation in ifconfig.8
On Sat, Aug 22, 2020 at 02:18:48PM -0700, Evan Silberman wrote: > Not to provoke a deep philosophical debate about the difference between > Ql, Cm, and Sy, but surely Em isn't the best choice here. A couple other > nits that bothered me in the same general region, I guess your taste > might vary. > > Evan Silberman > hi > --- > commit 233b62ce4e6cd3388e68f407e50758111b3eeffc (ifconfig.8) > from: Evan Silberman > date: Sat Aug 22 21:14:25 2020 UTC > > Improve markup and punctuation concerning groups > > - They're groups, not scare-quotes-"groups" oddly enough, this usage is probably close to what Em is meant for ;) quoting here is just another way to add that emphasis. but i agree it doesn;t make the text more readable. > - The markup for the default groups is debatable, but Cm seems closest. >You might also like: Ql, Sy i would prefer to use one macro rather than two. i agree Em is not great. i would just use Dq. > - Parenthesized plural(s) is (are) distracting > i heartily agree. so, if no one chips in soon, i will commit your diff, but with a straight Em->Dq replacement. jmc > diff cb34809c69289319bd78d14b4f5ed7d4e93b080f > c3c1549c9f1e94ec03820de542eaf10eaf0dc3f0 > blob - 9e6ad912b385de338033598de04f0184d015224e > blob + 968886c1a6d4849c4362ab2d759cc72c71d125ed > --- sbin/ifconfig/ifconfig.8 > +++ sbin/ifconfig/ifconfig.8 > @@ -238,8 +238,8 @@ transmit messages through that interface. > If possible, the interface will be reset to disable reception as well. > This action automatically disables routes using the interface. > .It Cm group Ar group-name > -Assign the interface to a > -.Dq group . > +Assign the interface to a group. > +The > .Ar group-name > may not be longer than 15 characters and must not end with a digit. > Any interface can be in multiple groups. > @@ -254,36 +254,35 @@ Some interfaces belong to specific groups by default: > .Bl -dash -width Ds -compact > .It > All interfaces are members of the > -.Em all > +.Cm all > interface group. > .It > Cloned interfaces are members of their interface family group. > For example, a PPP interface such as > -.Em ppp0 > +.Ql ppp0 > is a member of the > -.Em ppp > +.Cm ppp > interface family group. > .It > .Xr pppx 4 > interfaces are members of the > -.Em pppx > +.Cm pppx > interface group. > .It > -The interface(s) the default route(s) point to are members of the > -.Em egress > +The interfaces the default routes point to are members of the > +.Cm egress > interface group. > .It > IEEE 802.11 wireless interfaces are members of the > -.Em wlan > +.Cm wlan > interface group. > .It > Any interfaces used for network booting are members of the > -.Em netboot > +.Cm netboot > interface group. > .El > .It Cm -group Ar group-name > -Remove the interface from the given > -.Dq group . > +Remove the interface from the given group. > .It Cm hwfeatures > Display the interface hardware features: > .Pp >
Improve semantics and punctuation in ifconfig.8
Not to provoke a deep philosophical debate about the difference between Ql, Cm, and Sy, but surely Em isn't the best choice here. A couple other nits that bothered me in the same general region, I guess your taste might vary. Evan Silberman --- commit 233b62ce4e6cd3388e68f407e50758111b3eeffc (ifconfig.8) from: Evan Silberman date: Sat Aug 22 21:14:25 2020 UTC Improve markup and punctuation concerning groups - They're groups, not scare-quotes-"groups" - The markup for the default groups is debatable, but Cm seems closest. You might also like: Ql, Sy - Parenthesized plural(s) is (are) distracting diff cb34809c69289319bd78d14b4f5ed7d4e93b080f c3c1549c9f1e94ec03820de542eaf10eaf0dc3f0 blob - 9e6ad912b385de338033598de04f0184d015224e blob + 968886c1a6d4849c4362ab2d759cc72c71d125ed --- sbin/ifconfig/ifconfig.8 +++ sbin/ifconfig/ifconfig.8 @@ -238,8 +238,8 @@ transmit messages through that interface. If possible, the interface will be reset to disable reception as well. This action automatically disables routes using the interface. .It Cm group Ar group-name -Assign the interface to a -.Dq group . +Assign the interface to a group. +The .Ar group-name may not be longer than 15 characters and must not end with a digit. Any interface can be in multiple groups. @@ -254,36 +254,35 @@ Some interfaces belong to specific groups by default: .Bl -dash -width Ds -compact .It All interfaces are members of the -.Em all +.Cm all interface group. .It Cloned interfaces are members of their interface family group. For example, a PPP interface such as -.Em ppp0 +.Ql ppp0 is a member of the -.Em ppp +.Cm ppp interface family group. .It .Xr pppx 4 interfaces are members of the -.Em pppx +.Cm pppx interface group. .It -The interface(s) the default route(s) point to are members of the -.Em egress +The interfaces the default routes point to are members of the +.Cm egress interface group. .It IEEE 802.11 wireless interfaces are members of the -.Em wlan +.Cm wlan interface group. .It Any interfaces used for network booting are members of the -.Em netboot +.Cm netboot interface group. .El .It Cm -group Ar group-name -Remove the interface from the given -.Dq group . +Remove the interface from the given group. .It Cm hwfeatures Display the interface hardware features: .Pp
