[ovs-dev] [PATCH 1/2] ovs-ofctl: Consistently escape '-' in group documentation
Simon Horman
simon.horman at netronome.com
Tue Nov 18 02:31:50 UTC 2014
I am unsure of the reason for escaping '-' inside of control
sequences but regardless this patch makes the group documentation
consistent with other portions of the ovs-ofctl(8) in this regard.
Signed-off-by: Simon Horman <simon.horman at netronome.com>
---
utilities/ovs-ofctl.8.in | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index 4641461..d632f03 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -1942,8 +1942,8 @@ This field is required.
.IP \fBtype=\fItype\fR
-The type of the group. The \fBadd-group\fR, \fBadd-groups\fR and
-\fBdel-groups\fR commands require this field. It is prohibited for
+The type of the group. The \fBadd\-group\fR, \fBadd\-groups\fR and
+\fBdel\-groups\fR commands require this field. It is prohibited for
other commands. The following keywords designated the allowed types:
.RS
.IP \fBall\fR
@@ -1962,40 +1962,40 @@ a live port or group.
.RE
.IP \fBcommand_bucket_id=\fIid\fR
-The bucket to operate on. The \fBinsert-buckets\fR and \fBremove-buckets\fR
+The bucket to operate on. The \fBinsert\-buckets\fR and \fBremove\-buckets\fR
commands require this field. It is prohibited for other commands.
\fIid\fR may be an integer or one of the following keywords:
.RS
.IP \fBall\fR
Operate on all buckets in the group.
-Only valid when used with the \fBremove-buckets\fR command in which
+Only valid when used with the \fBremove\-buckets\fR command in which
case the effect is to remove all buckets from the group.
.IP \fBfirst\fR
Operate on the first bucket present in the group.
-In the case of the \fBinsert-buckets\fR command the effect is to
+In the case of the \fBinsert\-buckets\fR command the effect is to
insert new bucets just before the first bucket already present in the group;
or to replace the buckets of the group if there are no buckets already present
in the group.
-In the case of the \fBremove-buckets\fR command the effect is to
+In the case of the \fBremove\-buckets\fR command the effect is to
remove the first bucket of the group; or do nothing if there are no
buckets present in the group.
.IP \fBlast\fR
Operate on the last bucket present in the group.
-In the case of the \fBinsert-buckets\fR command the effect is to
+In the case of the \fBinsert\-buckets\fR command the effect is to
insert new bucets just after the last bucket already present in the group;
or to replace the buckets of the group if there are no buckets already present
in the group.
-In the case of the \fBremove-buckets\fR command the effect is to
+In the case of the \fBremove\-buckets\fR command the effect is to
remove the last bucket of the group; or do nothing if there are no
buckets present in the group.
.RE
.IP
If \fIid\fR is an integer then it should correspond to the \fBbucket_id\fR
of a bucket present in the group.
-In case of the \fBinsert-buckets\fR command the effect is to
+In case of the \fBinsert\-buckets\fR command the effect is to
insert buckets just before the bucket in the group whose \fBbucket_id\fR is
\fIid\fR.
-In case of the \fBiremove-buckets\fR command the effect is to
+In case of the \fBiremove\-buckets\fR command the effect is to
remove the in the group whose \fBbucket_id\fR is \fIid\fR.
It is an error if there is no bucket persent group in whose \fBbucket_id\fR is
\fIid\fR.
--
2.1.1
More information about the dev
mailing list