diff mbox

[ovs-dev,1/2] ovn-sbctl: Fix a few minor typesetting errors.

Message ID 20161209183832.2140-1-blp@ovn.org
State Accepted
Headers show

Commit Message

Ben Pfaff Dec. 9, 2016, 6:38 p.m. UTC 
In manpages, \- is used primarily for literal "-" in literal text, that is,
it should usually be used for bold (literal) text.  (It's also used for
minus signs in mathematics.)  It should not generally be used for hyphens
in English text, as it was used here in italic (metasyntactic variable)
text.  This fixes the problem.

Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 ovn/utilities/ovn-sbctl.8.in | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

Comments

Russell Bryant Dec. 9, 2016, 7:18 p.m. UTC | #1 
On Fri, Dec 9, 2016 at 1:38 PM, Ben Pfaff <blp@ovn.org> wrote:

> In manpages, \- is used primarily for literal "-" in literal text, that is,
> it should usually be used for bold (literal) text.  (It's also used for
> minus signs in mathematics.)  It should not generally be used for hyphens
> in English text, as it was used here in italic (metasyntactic variable)
> text.  This fixes the problem.
>
> Signed-off-by: Ben Pfaff <blp@ovn.org>
>

Acked-by: Russell Bryant <russell@ovn.org>
Ben Pfaff Dec. 10, 2016, 6:54 a.m. UTC | #2 
On Fri, Dec 09, 2016 at 02:18:23PM -0500, Russell Bryant wrote:
> On Fri, Dec 9, 2016 at 1:38 PM, Ben Pfaff <blp@ovn.org> wrote:
> 
> > In manpages, \- is used primarily for literal "-" in literal text, that is,
> > it should usually be used for bold (literal) text.  (It's also used for
> > minus signs in mathematics.)  It should not generally be used for hyphens
> > in English text, as it was used here in italic (metasyntactic variable)
> > text.  This fixes the problem.
> >
> > Signed-off-by: Ben Pfaff <blp@ovn.org>
> >
> 
> Acked-by: Russell Bryant <russell@ovn.org>

Thanks, applied to master.
diff mbox

Patch

diff --git a/ovn/utilities/ovn-sbctl.8.in b/ovn/utilities/ovn-sbctl.8.in
index 8036397..458a643 100644
--- a/ovn/utilities/ovn-sbctl.8.in
+++ b/ovn/utilities/ovn-sbctl.8.in
@@ -121,8 +121,8 @@  Prints a brief overview of the database contents.
 .SS "Chassis Commands"
 These commands manipulate \fBOVN_Southbound\fR chassis.
 .
-.IP "[\fB\-\-may\-exist\fR] \fBchassis\-add \fIchassis\fR \fIencap\-type\fR \fIencap-ip\fR"
-Creates a new chassis named \fIchassis\fR.  \fIencap\-type\fR is a
+.IP "[\fB\-\-may\-exist\fR] \fBchassis\-add \fIchassis\fR \fIencap-type\fR \fIencap-ip\fR"
+Creates a new chassis named \fIchassis\fR.  \fIencap-type\fR is a
 comma-separated list of tunnel types.  The chassis will have
 one encap entry for each specified tunnel type with \fIencap-ip\fR
 as the destination IP for each.
@@ -142,16 +142,16 @@  delete a chassis that does not exist has no effect.
 .
 These commands manipulate \fBOVN_Southbound\fR port bindings.
 .
-.IP "[\fB\-\-may\-exist\fR] \fBlsp\-bind \fIlogical\-port\fR \fIchassis\fR"
-Binds the logical port named \fIlogical\-port\fR to \fIchassis\fR.
+.IP "[\fB\-\-may\-exist\fR] \fBlsp\-bind \fIlogical-port\fR \fIchassis\fR"
+Binds the logical port named \fIlogical-port\fR to \fIchassis\fR.
 .IP
 Without \fB\-\-may\-exist\fR, attempting to bind a logical port that
 has already been bound is an error.  With \fB\-\-may\-exist\fR, this
-command does nothing if \fIlogical\-port\fR has already been bound to
+command does nothing if \fIlogical-port\fR has already been bound to
 a chassis.
 .
-.IP "[\fB\-\-if\-exists\fR] \fBlsp\-unbind\fR \fIlogical\-port\fR"
-Resets the binding of \fIlogical\-port\fR to \fINULL\fR.
+.IP "[\fB\-\-if\-exists\fR] \fBlsp\-unbind\fR \fIlogical-port\fR"
+Resets the binding of \fIlogical-port\fR to \fINULL\fR.
 .IP
 Without \fB\-\-if\-exists\fR, attempting to unbind a logical port
 that is not bound is an error.  With \fB\-\-if\-exists\fR, attempting
@@ -159,11 +159,11 @@  to unbind logical port that is not bound has no effect.
 .
 .SS "Logical Flow Commands"
 .
-.IP "\fBlflow\-list\fR [\fIlogical\-datapath\fR]"
-List logical flows. If \fIlogical\-datapath\fR is specified, only list flows for
-that logical datapath.
+.IP "\fBlflow\-list\fR [\fIlogical-datapath\fR]"
+List logical flows.  If \fIlogical-datapath\fR is specified, only list
+flows for that logical datapath.
 .
-.IP "\fBdump\-flows\fR [\fIlogical\-datapath\fR]"
+.IP "\fBdump\-flows\fR [\fIlogical-datapath\fR]"
 Alias for \fBlflow\-list\fB.
 .
 .so lib/db-ctl-base.man