TBR x/ref/cmd: Update package doc for all packages.
Change-Id: I5e7898b66f56e18c7c32668e8c31282be840296b
diff --git a/cmd/gclogs/doc.go b/cmd/gclogs/doc.go
index eddfe2f..712c356 100644
--- a/cmd/gclogs/doc.go
+++ b/cmd/gclogs/doc.go
@@ -6,7 +6,7 @@
// DO NOT UPDATE MANUALLY
/*
-gclogs is a utility that safely deletes old log files.
+Command gclogs safely deletes old log files.
It looks for file names that match the format of files produced by the vlog
package, and deletes the ones that have not changed in the amount of time
diff --git a/cmd/gclogs/gclogs.go b/cmd/gclogs/gclogs.go
index 1939b25..9160287 100644
--- a/cmd/gclogs/gclogs.go
+++ b/cmd/gclogs/gclogs.go
@@ -27,9 +27,9 @@
cmdGCLogs = &cmdline.Command{
Run: garbageCollectLogs,
Name: "gclogs",
- Short: "gclogs is a utility that safely deletes old log files.",
+ Short: "safely deletes old log files",
Long: `
-gclogs is a utility that safely deletes old log files.
+Command gclogs safely deletes old log files.
It looks for file names that match the format of files produced by the vlog
package, and deletes the ones that have not changed in the amount of time
diff --git a/cmd/mounttable/doc.go b/cmd/mounttable/doc.go
index 51b8ac1..db56b37 100644
--- a/cmd/mounttable/doc.go
+++ b/cmd/mounttable/doc.go
@@ -6,7 +6,7 @@
// DO NOT UPDATE MANUALLY
/*
-The mounttable tool facilitates interaction with a Vanadium mount table.
+Command mounttable sends commands to Vanadium mounttable services.
Usage:
mounttable <command>
diff --git a/cmd/mounttable/impl.go b/cmd/mounttable/impl.go
index c8a2bd2..f0adc71 100644
--- a/cmd/mounttable/impl.go
+++ b/cmd/mounttable/impl.go
@@ -197,9 +197,9 @@
func root() *cmdline.Command {
return &cmdline.Command{
Name: "mounttable",
- Short: "Tool for interacting with a Vanadium mount table",
+ Short: "sends commands to Vanadium mounttable services",
Long: `
-The mounttable tool facilitates interaction with a Vanadium mount table.
+Command mounttable sends commands to Vanadium mounttable services.
`,
Children: []*cmdline.Command{cmdGlob, cmdMount, cmdUnmount, cmdResolveStep},
}
diff --git a/cmd/namespace/doc.go b/cmd/namespace/doc.go
index 729d6c4..c7a3aa8 100644
--- a/cmd/namespace/doc.go
+++ b/cmd/namespace/doc.go
@@ -6,7 +6,7 @@
// DO NOT UPDATE MANUALLY
/*
-The namespace tool facilitates interaction with the Vanadium namespace.
+Command namespace resolves and manages names in the Vanadium namespace.
The namespace roots are set from the command line via --v23.namespace.root
command line option or from environment variables that have a name starting with
diff --git a/cmd/namespace/impl.go b/cmd/namespace/impl.go
index 08483ca..5380f01 100644
--- a/cmd/namespace/impl.go
+++ b/cmd/namespace/impl.go
@@ -209,9 +209,9 @@
cmdResolveToMT.Flags.BoolVar(&flagInsecureResolveToMT, "insecure", false, "Insecure mode: May return results from untrusted servers and invoke Resolve on untrusted mounttables")
return &cmdline.Command{
Name: "namespace",
- Short: "Tool for interacting with the Vanadium namespace",
+ Short: "resolves and manages names in the Vanadium namespace",
Long: `
-The namespace tool facilitates interaction with the Vanadium namespace.
+Command namespace resolves and manages names in the Vanadium namespace.
The namespace roots are set from the command line via --v23.namespace.root
command line option or from environment variables that have a name starting
diff --git a/cmd/principal/doc.go b/cmd/principal/doc.go
index 5a534c3..2315060 100644
--- a/cmd/principal/doc.go
+++ b/cmd/principal/doc.go
@@ -6,8 +6,7 @@
// DO NOT UPDATE MANUALLY
/*
-The principal tool helps create and manage blessings and the set of trusted
-roots bound to a principal.
+Command principal creates and manages Vanadium principals and blessings.
All objects are printed using base64-VOM-encoding.
diff --git a/cmd/principal/main.go b/cmd/principal/main.go
index a5b2305..41845d9 100644
--- a/cmd/principal/main.go
+++ b/cmd/principal/main.go
@@ -858,10 +858,9 @@
root := &cmdline.Command{
Name: "principal",
- Short: "Create and manage vanadium principals",
+ Short: "creates and manages Vanadium principals and blessings",
Long: `
-The principal tool helps create and manage blessings and the set of trusted
-roots bound to a principal.
+Command principal creates and manages Vanadium principals and blessings.
All objects are printed using base64-VOM-encoding.
`,
diff --git a/cmd/servicerunner/main.go b/cmd/servicerunner/main.go
index fb6abaa..fa54314 100644
--- a/cmd/servicerunner/main.go
+++ b/cmd/servicerunner/main.go
@@ -2,8 +2,9 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
-// This binary starts several services (mount table, proxy, wspr), then prints a
-// JSON map with their vars to stdout (as a single line), then waits forever.
+// Command servicerunner runs several Vanadium services, including the
+// mounttable, proxy and wspr. It prints a JSON map with their vars to stdout
+// (as a single line), then waits forever.
package main
import (
diff --git a/cmd/uniqueid/doc.go b/cmd/uniqueid/doc.go
index 1b6e4df..7fb5ff1 100644
--- a/cmd/uniqueid/doc.go
+++ b/cmd/uniqueid/doc.go
@@ -6,8 +6,8 @@
// DO NOT UPDATE MANUALLY
/*
-The uniqueid tool generates unique ids. It also has an option of automatically
-substituting unique ids with placeholders in files.
+Command uniqueid generates unique identifiers. It also has an option of
+automatically substituting unique ids with placeholders in files.
Usage:
uniqueid <command>
diff --git a/cmd/uniqueid/main.go b/cmd/uniqueid/main.go
index e072764..ca89740 100644
--- a/cmd/uniqueid/main.go
+++ b/cmd/uniqueid/main.go
@@ -34,9 +34,9 @@
var cmdUniqueId = &cmdline.Command{
Name: "uniqueid",
- Short: "Generates UniqueIds.",
+ Short: "generates unique identifiers",
Long: `
-The uniqueid tool generates unique ids.
+Command uniqueid generates unique identifiers.
It also has an option of automatically substituting unique ids with placeholders in files.
`,
Children: []*cmdline.Command{cmdGenerate, cmdInject},
diff --git a/cmd/vdl/doc.go b/cmd/vdl/doc.go
index 2b34150..7d12ec5 100644
--- a/cmd/vdl/doc.go
+++ b/cmd/vdl/doc.go
@@ -6,8 +6,8 @@
// DO NOT UPDATE MANUALLY
/*
-The vdl tool manages vanadium VDL source code. It's similar to the go tool used
-for managing Go source code.
+Command vdl manages Vanadium Definition Language source code. It's similar to
+the go tool used for managing Go source code.
Usage:
vdl [flags] <command>
diff --git a/cmd/vdl/main.go b/cmd/vdl/main.go
index fb695a3..3f57f9c 100644
--- a/cmd/vdl/main.go
+++ b/cmd/vdl/main.go
@@ -355,10 +355,10 @@
// Root returns the root command for the VDL tool.
var cmdVDL = &cmdline.Command{
Name: "vdl",
- Short: "Manage vanadium VDL source code",
+ Short: "manages Vanadium Definition Language source code",
Long: `
-The vdl tool manages vanadium VDL source code. It's similar to the go tool used
-for managing Go source code.
+Command vdl manages Vanadium Definition Language source code. It's similar to
+the go tool used for managing Go source code.
`,
Children: []*cmdline.Command{cmdGenerate, cmdCompile, cmdAudit, cmdList},
Topics: []cmdline.Topic{topicPackages, topicVdlPath, topicVdlRoot, topicVdlConfig},
diff --git a/cmd/vom/doc.go b/cmd/vom/doc.go
index 7c24a80..dcefc2b 100644
--- a/cmd/vom/doc.go
+++ b/cmd/vom/doc.go
@@ -6,7 +6,7 @@
// DO NOT UPDATE MANUALLY
/*
-The vom tool helps debug the Vanadium Object Marshaling (vom) protocol.
+Command vom helps debug the Vanadium Object Marshaling wire protocol.
Usage:
vom <command>
diff --git a/cmd/vom/vom.go b/cmd/vom/vom.go
index 7a99a60..16b5847 100644
--- a/cmd/vom/vom.go
+++ b/cmd/vom/vom.go
@@ -38,9 +38,9 @@
var cmdVom = &cmdline.Command{
Name: "vom",
- Short: "Vanadium Object Marshaling debugging tool",
+ Short: "helps debug the Vanadium Object Marshaling wire protocol",
Long: `
-The vom tool helps debug the Vanadium Object Marshaling (vom) protocol.
+Command vom helps debug the Vanadium Object Marshaling wire protocol.
`,
Children: []*cmdline.Command{cmdDecode, cmdDump},
}
diff --git a/cmd/vomtestgen/doc.go b/cmd/vomtestgen/doc.go
index 67e37b3..4411a64 100644
--- a/cmd/vomtestgen/doc.go
+++ b/cmd/vomtestgen/doc.go
@@ -6,8 +6,10 @@
// DO NOT UPDATE MANUALLY
/*
-The vomtestgen tool generates vom test data, using the vomdata file as input,
-and creating a vdl file as output.
+Command vomtestgen generates test data for the vom wire protocol implementation.
+It takes as input a vdl config file, and outputs a vdl package with test cases.
+Test data is generated using this tool to make it easy to add many test cases,
+and verify them in implementations in different languages
Usage:
vomtestgen [flags] [vomdata]
diff --git a/cmd/vomtestgen/generate.go b/cmd/vomtestgen/generate.go
index 1a2bd50..cb53110 100644
--- a/cmd/vomtestgen/generate.go
+++ b/cmd/vomtestgen/generate.go
@@ -33,10 +33,12 @@
var cmdGenerate = &cmdline.Command{
Run: runGenerate,
Name: "vomtestgen",
- Short: "Generate test data for the vom encoder / decoder",
+ Short: "generates test data for the vom wire protocol implementation",
Long: `
-The vomtestgen tool generates vom test data, using the vomdata file as input,
-and creating a vdl file as output.
+Command vomtestgen generates test data for the vom wire protocol implementation.
+It takes as input a vdl config file, and outputs a vdl package with test cases.
+Test data is generated using this tool to make it easy to add many test cases,
+and verify them in implementations in different languages
`,
ArgsName: "[vomdata]",
ArgsLong: `
diff --git a/cmd/vrpc/doc.go b/cmd/vrpc/doc.go
index caf236a..07e6c23 100644
--- a/cmd/vrpc/doc.go
+++ b/cmd/vrpc/doc.go
@@ -6,8 +6,8 @@
// DO NOT UPDATE MANUALLY
/*
-The vrpc tool provides command-line access to Vanadium servers via Remote
-Procedure Call.
+Command vrpc sends and receives Vanadium remote procedure calls. It is used as
+a generic client to interact with any Vanadium server.
Usage:
vrpc <command>
diff --git a/cmd/vrpc/vrpc.go b/cmd/vrpc/vrpc.go
index a00f86e..bde1970 100644
--- a/cmd/vrpc/vrpc.go
+++ b/cmd/vrpc/vrpc.go
@@ -54,10 +54,10 @@
var cmdVRPC = &cmdline.Command{
Name: "vrpc",
- Short: "Vanadium Remote Procedure Call tool",
+ Short: "sends and receives Vanadium remote procedure calls",
Long: `
-The vrpc tool provides command-line access to Vanadium servers via Remote
-Procedure Call.
+Command vrpc sends and receives Vanadium remote procedure calls. It is used as
+a generic client to interact with any Vanadium server.
`,
// TODO(toddw): Add cmdServe, which will take an interface as input, and set
// up a server capable of handling the given methods. When a request is
diff --git a/cmd/vrun/doc.go b/cmd/vrun/doc.go
index 29d609a..293a3d2 100644
--- a/cmd/vrun/doc.go
+++ b/cmd/vrun/doc.go
@@ -2,8 +2,11 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// This file was auto-generated via go generate.
+// DO NOT UPDATE MANUALLY
+
/*
-The vrun tool executes a command with a derived principal.
+Command vrun executes commands with a derived Vanadium principal.
Usage:
vrun [flags] <command> [command args...]
@@ -13,6 +16,10 @@
Duration for the blessing.
-name=
Name to use for the blessing. Uses the command name if unset.
+ -role=
+ Role object from which to request the blessing. If set, the blessings from
+ this role server are used and --name is ignored. If not set, the default
+ blessings of the calling principal are extended with --name.
The global flags are:
-alsologtostderr=true
@@ -29,15 +36,27 @@
logs at or above this threshold go to stderr
-v=0
log level for V logs
- -veyron.credentials=
+ -v23.credentials=
directory to use for storing security credentials
- -veyron.namespace.root=[/ns.dev.v.io:8101]
+ -v23.i18n-catalogue=
+ 18n catalogue files to load, comma separated
+ -v23.namespace.root=[/ns.dev.v.io:8101]
local namespace root; can be repeated to provided multiple roots
- -veyron.vtrace.cache_size=1024
+ -v23.proxy=
+ object name of proxy service to use to export services across network
+ boundaries
+ -v23.tcp.address=
+ address to listen on
+ -v23.tcp.protocol=wsh
+ protocol to listen with
+ -v23.vtrace.cache-size=1024
The number of vtrace traces to store in memory.
- -veyron.vtrace.dump_on_shutdown=false
+ -v23.vtrace.collect-regexp=
+ Spans and annotations that match this regular expression will trigger trace
+ collection.
+ -v23.vtrace.dump-on-shutdown=true
If true, dump all stored traces on runtime shutdown.
- -veyron.vtrace.sample_rate=0
+ -v23.vtrace.sample-rate=0
Rate (from 0.0 to 1.0) to sample vtrace traces.
-vmodule=
comma-separated list of pattern=N settings for file-filtered logging
diff --git a/cmd/vrun/vrun.go b/cmd/vrun/vrun.go
index a61e720..81c3976 100644
--- a/cmd/vrun/vrun.go
+++ b/cmd/vrun/vrun.go
@@ -2,6 +2,9 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// The following enables go generate to generate the doc.go file.
+//go:generate go run $V23_ROOT/release/go/src/v.io/x/lib/cmdline/testdata/gendoc.go . -help
+
package main
import (
@@ -33,8 +36,8 @@
var cmdVrun = &cmdline.Command{
Run: vrun,
Name: "vrun",
- Short: "Executes a command with a derived principal.",
- Long: "The vrun tool executes a command with a derived principal.",
+ Short: "executes commands with a derived Vanadium principal",
+ Long: "Command vrun executes commands with a derived Vanadium principal.",
ArgsName: "<command> [command args...]",
}
