X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-doc.in;h=5ba4e71682ec7e5491843046cb8ef0c8d4d6567e;hb=1c2e2d2fc87c9435b6fe33112b0ddaab59f507c5;hp=9e0a318d2b9fb41366cae87e4d77d0589029fa7d;hpb=c94238565522c51a117a7f89fecaabd2605b7c66;p=openvswitch diff --git a/ovsdb/ovsdb-doc.in b/ovsdb/ovsdb-doc.in index 9e0a318d..5ba4e716 100755 --- a/ovsdb/ovsdb-doc.in +++ b/ovsdb/ovsdb-doc.in @@ -177,7 +177,7 @@ def tableSummaryToNroff(summary, level=0): s = "" for type, name, arg in summary: if type == 'column': - + s += "%s\\fB%s\\fR\tT{\n%s\nT}\n" % ( r'\ \ ' * level, name, typeAndConstraintsToNroff(arg)) else: @@ -221,11 +221,11 @@ Column Type def docsToNroff(schemaFile, xmlFile, erFile, title=None): schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schemaFile)) doc = xml.dom.minidom.parse(xmlFile).documentElement - + schemaDate = os.stat(schemaFile).st_mtime xmlDate = os.stat(xmlFile).st_mtime d = date.fromtimestamp(max(schemaDate, xmlDate)) - + if title == None: title = schema.name @@ -290,9 +290,11 @@ Table Purpose .SH "TABLE RELATIONSHIPS" .PP The following diagram shows the relationship among tables in the -database. Each node represents a table. Each edge leads from the +database. Each node represents a table. Tables that are part of the +``root set'' are shown with double borders. Each edge leads from the table that contains it and points to the table that its value -represents. Edges are labeled with their column names. +represents. Edges are labeled with their column names. Thick lines +represent strong references; thin lines represent weak references. .RS -1in """ erStream = open(erFile, "r") @@ -344,19 +346,19 @@ if __name__ == "__main__": print "ovsdb-doc (Open vSwitch) @VERSION@" else: sys.exit(0) - + if len(args) != 2: sys.stderr.write("%s: exactly 2 non-option arguments required " "(use --help for help)\n" % argv0) sys.exit(1) - + # XXX we should warn about undocumented tables or columns s = docsToNroff(args[0], args[1], er_diagram) for line in s.split("\n"): line = line.strip() if len(line): print line - + except error.Error, e: sys.stderr.write("%s: %s\n" % (argv0, e.msg)) sys.exit(1)