[ovs-dev,3/3] ovs-ofctl.8.in: Fix minor formatting issues.
diff mbox

Message ID 1474050422-4330-3-git-send-email-jpettit@ovn.org
State Accepted
Headers show

Commit Message

Justin Pettit Sept. 16, 2016, 6:27 p.m. UTC
Signed-off-by: Justin Pettit <jpettit@ovn.org>
---
 utilities/ovs-ofctl.8.in | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Ben Pfaff Sept. 19, 2016, 3:26 p.m. UTC | #1
On Fri, Sep 16, 2016 at 11:27:02AM -0700, Justin Pettit wrote:
> Signed-off-by: Justin Pettit <jpettit@ovn.org>

Please drop the changes from "flow-based" to "flow\-based".  The rule
for "-" versus "\-" in nroff isn't "put \ before every -", but instead
more like "put \ before a literal - in sample syntax".  The fuller
version of the rule is that - is a hyphen and \- is a minus sign; you
want the former in "flow-based" and the latter in e.g. "--dry-run".

I'll get off my high horse now.

Anyway, except for those particular changes,
Acked-by: Ben Pfaff <blp@ovn.org>
Justin Pettit Sept. 19, 2016, 4:16 p.m. UTC | #2
> On Sep 19, 2016, at 8:26 AM, Ben Pfaff <blp@ovn.org> wrote:
> 
> On Fri, Sep 16, 2016 at 11:27:02AM -0700, Justin Pettit wrote:
>> Signed-off-by: Justin Pettit <jpettit@ovn.org>
> 
> Please drop the changes from "flow-based" to "flow\-based".  The rule
> for "-" versus "\-" in nroff isn't "put \ before every -", but instead
> more like "put \ before a literal - in sample syntax".  The fuller
> version of the rule is that - is a hyphen and \- is a minus sign; you
> want the former in "flow-based" and the latter in e.g. "--dry-run".
> 
> I'll get off my high horse now.
> 
> Anyway, except for those particular changes,
> Acked-by: Ben Pfaff <blp@ovn.org>

Thanks for the explanation.  I made that change and pushed the series to master.

--Justin

Patch
diff mbox

diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index 249b28a..cf39fff 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -255,7 +255,7 @@  This command has limited usefulness, because ports often have no
 configured queues and because the OpenFlow protocol provides only very
 limited information about the configuration of a queue.
 .
-.IP "\fBdump\-ipfix\-bridge \fIswitch
+.IP "\fBdump\-ipfix\-bridge \fIswitch\fR"
 Prints to the console the statistics of bridge IPFIX for \fIswitch\fR.
 If bridge IPFIX is configured on the \fIswitch\fR, IPFIX statistics
 can be retrieved.  Otherwise, error message will be printed.
@@ -263,13 +263,13 @@  can be retrieved.  Otherwise, error message will be printed.
 This command uses an Open vSwitch extension that is only in Open
 vSwitch 2.6 and later.
 .
-.IP "\fBdump\-ipfix\-flow \fIswitch
-Prints to the console the statistics of flow-based IPFIX for
-\fIswitch\fR.  If flow-based IPFIX is configured on the \fIswitch\fR,
+.IP "\fBdump\-ipfix\-flow \fIswitch\fR"
+Prints to the console the statistics of flow\-based IPFIX for
+\fIswitch\fR.  If flow\-based IPFIX is configured on the \fIswitch\fR,
 statistics of all the collector set ids on the \fIswitch\fR will be
 printed.  Otherwise, print error message.
 .IP
-Refer to \fBovs-vswitchd.conf.db\fR(5) for more details on configuring
+Refer to \fBovs\-vswitchd.conf.db\fR(5) for more details on configuring
 flow based IPFIX and collector set ids.
 .IP
 This command uses an Open vSwitch extension that is only in Open