[ovs-dev] [PATCH 4/6] doc: Consistently escape bundle_load() arguments

Ben Pfaff blp at nicira.com
Wed Aug 24 16:49:30 UTC 2011


On Wed, Aug 24, 2011 at 10:40:54AM +0900, Simon Horman wrote:
> This escapes the arguments to the bundle_load() example
> in the same way that the description above is escaped.
> 
> This resolves a warning reported as
> "71: warning [p 11, 5.0i]: cannot adjust line"
> 
> Reported by lintian

Thank you.

The escaping in the description is there to distinguish literal text
(bold) from metasyntactic variables (italic) and operators (Roman).
The example is all literal text so it's all bold.

I committed this instead:

--8<--------------------------cut here-------------------------->8--

From: Ben Pfaff <blp at nicira.com>
Date: Wed, 24 Aug 2011 09:45:18 -0700
Subject: [PATCH] doc: Add spaces between commas to avoid overflowing line
 during formatting.

This resolves a warning reported as
"71: warning [p 11, 5.0i]: cannot adjust line"

Reported-by: Simon Horman <horms at verge.net.au>
Found by lintian.
---
 utilities/ovs-ofctl.8.in |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index 7ce1ea9..cddde1f 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -769,10 +769,10 @@ of outputting to the selected slave, it writes its selection to
 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as described
 above.
 .IP
-Example: \fBbundle_load(eth_src,0,hrw,ofport,NXM_NX_REG0[],slaves:4,8)\fR uses
-an Ethernet source hash with basis 0, to select between OpenFlow ports 4 and 8
-using the Highest Random Weight algorithm, and writes the selection to
-\fBNXM_NX_REG0[]\fR.
+Example: \fBbundle_load(eth_src, 0, hrw, ofport, NXM_NX_REG0[],
+slaves:4, 8)\fR uses an Ethernet source hash with basis 0, to select
+between OpenFlow ports 4 and 8 using the Highest Random Weight
+algorithm, and writes the selection to \fBNXM_NX_REG0[]\fR.
 .IP
 Refer to \fBnicira\-ext.h\fR for more details.
 .RE
-- 
1.7.4.4




More information about the dev mailing list