[ovs-dev] [PATCH] Fix type-setting in ovsdb-idlc man page.
Jakub Sitnicki
jkbs at redhat.com
Wed Feb 28 16:06:45 UTC 2018
- Remove extra escape sequences for switching to bold font.
- Add missing escape sequences for switching back to normal font.
Reported-at: https://mail.openvswitch.org/pipermail/ovs-dev/2018-February/344591.html
Signed-off-by: Jakub Sitnicki <jkbs at redhat.com>
---
ovsdb/ovsdb-idlc.1 | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/ovsdb/ovsdb-idlc.1 b/ovsdb/ovsdb-idlc.1
index cc78b66c4..1e9f30ca7 100644
--- a/ovsdb/ovsdb-idlc.1
+++ b/ovsdb/ovsdb-idlc.1
@@ -33,30 +33,30 @@ The \fIidl\fR files used as input for most \fBovsdb\-idlc\fR commands
have the same format as the OVSDB schemas, specified in the OVSDB
specification, with a few additions:
.
-.IP "\fB""\fBidlPrefix\fR"" member of <database-schema>"
+.IP """\fBidlPrefix\fR"" member of <database-schema>"
This member, which is required, specifies a string that is prefixed to
top-level names in C bindings. It should probably end in an
underscore.
.
-.IP "\fB""\fBidlHeader\fR"" member of <database-schema>"
+.IP """\fBidlHeader\fR"" member of <database-schema>"
This member, which is required, specifies the name of the IDL header.
It will be output on an \fB#include\fR line in the source file
generated by the C bindings. It should include the bracketing
\fB""\fR or \fB<>\fR.
.
-.IP "\fB""\fBcDecls\fR"" member of <database-schema>"
-.IQ "\fB""\fBhDecls\fR"" member of <database-schema>"
+.IP """\fBcDecls\fR"" member of <database-schema>"
+.IQ """\fBhDecls\fR"" member of <database-schema>"
These optional members may specify arbitrary code to include in the
generated \fB.c\fR or \fB.h\fR file, respectively, in each case just
after the \fB#include\fR directives in those files.
.
-.IP "\fB""\fBextensions\fR"" member of <table-schema>"
-.IQ "\fB""\fBextensions\fR"" member of <column-schema>"
+.IP """\fBextensions\fR"" member of <table-schema>"
+.IQ """\fBextensions\fR"" member of <column-schema>"
This member is optional. If specified, it is an object whose contents
describes extensions to the OVSDB schema language, for the purpose of
specifying interpretation by the IDL.
.
-.IP "\fB""\fBsynthetic\fR"" member of <column-schema> ""\fBextensions\fR"" object"
+.IP """\fBsynthetic\fR"" member of <column-schema> ""\fBextensions\fR"" object"
If this optional member is set to \fBtrue\fR, then it indicates that
the column is not expected to be found in the actual database.
Instead, code supplied by the IDL's client fills in the desired
@@ -64,24 +64,24 @@ structure members based on the value of one or more other database
columns. This can be used to cache the result of a calculation, for
example.
.
-.IP "\fB""\fBparse\fR"" member of <column-schema> ""\fBextensions\fR"" object"
+.IP """\fBparse\fR"" member of <column-schema> ""\fBextensions\fR"" object"
This member should be present if and only if the column is synthetic.
It should be a string that contains C code to set the value of the
column's member in an object named \fBrow\fR, e.g. "\fBrow->column =
-1;" if the column's name is \fBcolumn\fR and has integer type. The
+1;\fR" if the column's name is \fBcolumn\fR and has integer type. The
code may rely on the columns named in \fBdependencies\fR to be
initialized. The function can get called for rows that do not satisfy
the constraints in the schema, e.g. that a pointer to another is
nonnull, so it must not rely on those constraints.
.
-.IP "\fB""\fBunparse\fR"" member of <column-schema> ""\fBextensions\fR"" object"
+.IP """\fBunparse\fR"" member of <column-schema> ""\fBextensions\fR"" object"
This member is honored only if the column is synthetic. It should be
a string that contains C code to free the data in the column's member
-in an object named \fBrow\fR, e.g. "\fBfree(row->column);" if the
+in an object named \fBrow\fR, e.g. "\fBfree(row->column);\fR" if the
column's name is \fBcolumn\fR and points to data that was allocated by
the \fBparse\fR function and needs to be freed.
.
-.IP "\fB""\fBdependencies\fR"" member of <column-schema> ""\fBextensions\fR"" object"
+.IP """\fBdependencies\fR"" member of <column-schema> ""\fBextensions\fR"" object"
This member should be a list of the names of columns whose values are
used by the code in \fBparse\fR and \fBunparse\fR. The IDL ensures
that dependencies are parsed before the columns that depends on them,
--
2.14.3
More information about the dev
mailing list