ref: Add short description to godoc headers.
The auto-generated doc.go file for cmdline tools is formatted
specially so that godoc will interpret each command as a header,
which gets automatically linked to a table of contents. This
change adds the short description from each command or help
topic, to make the TOC more useful.
Note that godoc has heurisitics for what it considers an
appropriate header; e.g. if the line contains certain puncutation
it won't be extracted as a header. For these cases we fall back
and only use the command path, since it's better to have a less
descriptive header than to have no header at all.
Also added LineWriter.ForceVerbatim, which lets us force verbatim
mode. This is used to ensure the header line we generate isn't
wrapped into more than one line.
MultiPart: 3/3
Change-Id: I7f797d2f3945e3b1ff55bc513a9a8bd2d98a5e8c
diff --git a/cmd/vom/doc.go b/cmd/vom/doc.go
index e34f185..dc1e047 100644
--- a/cmd/vom/doc.go
+++ b/cmd/vom/doc.go
@@ -20,7 +20,7 @@
-v23.metadata=<just specify -v23.metadata to activate>
Displays metadata for the program and exits.
-Vom decode
+Vom decode - Decode data encoded in the vom format
Decode decodes data encoded in the vom format. If no arguments are provided,
decode reads the data from stdin, otherwise the argument is the data.
@@ -38,7 +38,7 @@
-data=Hex
Data representation, one of [Hex Binary]
-Vom dump
+Vom dump - Dump data encoded in the vom format into formatted output
Dump dumps data encoded in the vom format, generating formatted output
describing each portion of the encoding. If no arguments are provided, dump
@@ -68,7 +68,7 @@
-data=Hex
Data representation, one of [Hex Binary]
-Vom help
+Vom help - Display help for commands or topics
Help with no args displays the usage of the parent command.
