aboutsummaryrefslogtreecommitdiff
path: root/ovsdb/ovsdb-doc.in
AgeCommit message (Collapse)Author
2012-03-19ovsdb-doc: Use minus sign in negative numbers in nroff output.Ben Pfaff
ovs-vswitchd.conf.db.5 has autogenerated text "at least -1" in one place. This '-' should be a minus sign, but ovsdb-doc was generating it as a hyphen. Found by lintian. Reported-by: Thomas Goirand <zigo@debian.org> Reviewed-by: Simon Horman <horms@verge.net.au> Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-03-19ovsdb-doc: Convert '-' preceding a number as a minus sign, not a hyphen.Ben Pfaff
ovs-vswitchd.conf.db.5 contains the following sentence: If the interface cannot be added then Open vSwitch sets this column to -1. The '-' in "-1" should be a minus sign, not a hyphen, but the heuristic in ovsdb-doc wasn't smart enough. This commit improves the heuristic and fixes the problem. Found by lintian. Reported-by: Thomas Goirand <zigo@debian.org> Reviewed-by: Simon Horman <horms@verge.net.au> Signed-off-by: Ben Pfaff <blp@nicira.com>
2012-03-19ovsdb-doc: Put NAME section into generated manpage.Ben Pfaff
This makes the manpage indexable by standard system tools. Found by lintian. Reported-by: Thomas Goirand <zigo@debian.org> Reviewed-by: Simon Horman <horms@verge.net.au> Signed-off-by: Ben Pfaff <blp@nicira.com>
2011-12-09man: fix pic issue at the sourceChris Wright
The commit 0993b66 (man: pic failed to run during manpage-check) worked around the manpage-check warning generated by groff. Using "-T ascii" rather "-T utf8" was enough to silence the warning because the man page has this condition in it: .if !'\*[.T]'ascii' However, rpmlint generates the same warning as manpage-check was (it uses -Tutf8), and manpages are generated using -Tutf8 (leading to an fairly unreadable drawing). So let's change the logic a bit and allow pdf generation w/ nice drawing and kill it for tty's. Cc: Ethan Jackson <ethan@nicira.com> Signed-off-by: Chris Wright <chrisw@sous-sol.org> Signed-off-by: Ben Pfaff <blp@nicira.com>
2011-10-12vswitchd: Document constraints on keys.Ben Pfaff
Suggested-by: Justin Pettit <jpettit@nicira.com>
2011-10-04vswitchd: Document map members as separate columnsBen Pfaff
The OVS configuration database now has numerous columns that contain fixed key-value pairs. Currently there's no way to see these at a glance, because they are not presented in the summary tables just before the detailed descriptions. This commit extends the XML format so that keys within a column can be described individually, and rearranges and rewrites vswitch.xml to take advantage of this feature.
2011-08-24docs: Fix some manpage syntax errors found with "groff".Ben Pfaff
2011-07-26ovsdb-doc: Fix definition of .TQ macro.Ben Pfaff
.TP's argument is an optional indentation width, not a string. The string goes on the next line. vswitch.xml didn't actually cause .TQ to be used before, so this wasn't a problem, but an upcoming commit does add a use, so this commit fixes the problem in advance.
2011-06-21ovsdb-doc: Add support for references to specific keys.Ben Pfaff
Now a specific key can be referenced with syntax like <ref table="Bridge" column="other-config" key="datapath-id"/>. Also fixes up an existing place that needed this feature already (and had a typo, too).
2011-06-06ovsdb: Implement table uniqueness constraints ("indexes").Ben Pfaff
2011-05-26ovsdb-doc: Omit E-R diagram from ASCII version of manpage.Ben Pfaff
The E-R diagram is illegible when rendered in ASCII, so exclude it from that version only. The E-R diagram is still included in other versions of the manpage (e.g. for PostScript output).
2011-05-24ovsdb: Annotate E-R diagram with number of allowed values.Ben Pfaff
This makes the diagram even more informative.
2011-03-10ovsdb: Implement garbage collection.Ben Pfaff
2010-11-29ovsdb: Remove trailing whitespaceEthan Jackson
This commit removes trailing whitespace from the files in the ovsdb directory.
2010-09-23ovsdb-doc: Implement new <option>, <ol> tags.Ben Pfaff
2010-08-25Implement initial Python bindings for Open vSwitch database.Ben Pfaff
These initial bindings pass a few hundred of the corresponding tests for C implementations of various bits of the Open vSwitch library API. The poorest part of them is actually the Python IDL interface in ovs.db.idl, which has not received enough attention yet. It appears to work, but it doesn't yet support writes (transactions) and it is difficult to use. I hope to improve it as it becomes clear what semantics Python applications actually want from an IDL.
2010-06-24vswitchd: Add entity-relationship diagram to ovs-vswitchd.conf.db.5.Ben Pfaff
I've updated http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf with example output.
2010-04-20ovsdb-doc: Distinguish hyphens and minus signs in nroff output.Ben Pfaff
In nroff, a minus sign (\-) should generally be used in literal text, whereas hyphens are generally correct elsewhere. This roughly corresponds to bold versus non-bold text, so this commit makes ovsdb-doc output "-" that appears in input as a minus sign if it is bold or a hyphen if it is not.
2010-03-05Add documentation for the vswitch database schema.Ben Pfaff
We can do better than this (I already have some comments) but this is still much better than what we had.