diff options
author | Martin Polden <mpolden@mpolden.no> | 2023-11-30 15:48:11 +0100 |
---|---|---|
committer | Martin Polden <mpolden@mpolden.no> | 2023-11-30 15:52:44 +0100 |
commit | cf9add5915b5e070265a5a4418aab38765461b7d (patch) | |
tree | 565a0bc6c5636dcb1c12d2afec44afda6823500c /client/go | |
parent | 8167e8d3aecb518c9791f65dcf15d9aea2169c63 (diff) |
Improve config doc
Diffstat (limited to 'client/go')
-rw-r--r-- | client/go/internal/cli/cmd/config.go | 24 | ||||
-rw-r--r-- | client/go/internal/cli/cmd/gendoc.go | 2 |
2 files changed, 13 insertions, 13 deletions
diff --git a/client/go/internal/cli/cmd/config.go b/client/go/internal/cli/cmd/config.go index d169c3c8d54..fc6d69aab61 100644 --- a/client/go/internal/cli/cmd/config.go +++ b/client/go/internal/cli/cmd/config.go @@ -33,9 +33,9 @@ func newConfigCmd() *cobra.Command { Short: "Manage persistent values for global flags", Long: `Manage persistent values for global flags. -This command allows setting persistent values for global flags. On future -invocations the flag can then be omitted as it is read from the config file -instead. +This command allows setting persistent values for the global flags found in +Vespa CLI. On future invocations the flag can then be omitted as it is read + from the config file instead. Configuration is written to $HOME/.vespa by default. This path can be overridden by setting the VESPA_CLI_HOME environment variable. @@ -58,16 +58,16 @@ The following global flags/options can be configured: application Specifies the application ID to manage. It has three parts, separated by -dots, with the third part being optional. If the part is omitted it defaults to -"default". This is only relevant for the "cloud" and "hosted" targets. See -https://cloud.vespa.ai/en/tenant-apps-instances for more details. This has no -default value. Examples: tenant1.app1, tenant1.app1.instance1 +dots, with the third part being optional. If the third part is omitted it +defaults to "default". This is only relevant for the "cloud" and "hosted" +targets. See https://cloud.vespa.ai/en/tenant-apps-instances for more details. +This has no default value. Examples: tenant1.app1, tenant1.app1.instance1 cluster Specifies the container cluster to manage. If left empty (default) and the application has only one container cluster, that cluster is chosen -automatically. When an application has multiple cluster this must be set a +automatically. When an application has multiple cluster this must specify a valid cluster name, as specified in services.xml. See https://docs.vespa.ai/en/reference/services-container.html for more details. @@ -80,9 +80,9 @@ colors if supported by the terminal, "never" completely disables colors and instance Specifies the instance of the application to manage. When specified, this takes -precedence over the instance specified as part of application. This has no -default value and is only relevant for the "cloud" and "hosted" targets. -Example: instance2 +precedence over the instance specified as part of the 'application' option. +This has no default value and is only relevant for the "cloud" and "hosted" +targets. Example: instance2 quiet @@ -107,7 +107,7 @@ e.g. vespa deploy or vespa query. Possible values are: Authentication is configured automatically for the cloud and hosted targets. To set a custom private key and certificate, e.g. for use with a self-hosted Vespa -installation using mTLS, see the documentation of 'vespa auth cert'. +installation configured with mTLS, see the documentation of 'vespa auth cert'. zone diff --git a/client/go/internal/cli/cmd/gendoc.go b/client/go/internal/cli/cmd/gendoc.go index 62415111035..c440805cb9e 100644 --- a/client/go/internal/cli/cmd/gendoc.go +++ b/client/go/internal/cli/cmd/gendoc.go @@ -11,7 +11,7 @@ import ( func newGendocCmd(cli *CLI) *cobra.Command { return &cobra.Command{ Use: "gendoc directory", - Short: "Generate documentation from '--help' pages and write as markdown files to a given directory", + Short: "Generate documentation from '--help' pages and write as Markdown files to a given directory", Args: cobra.ExactArgs(1), Hidden: true, // Not intended to be called by users DisableAutoGenTag: true, |