luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Make docs for params clearer

This commit is contained in:
Joel Watson 2020-11-10 10:35:24 -06:00
parent 0553532e00
commit 4298a0f7e1
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
command/snapshot/inspect/snapshot_inspect.go
View File

@ -39,11 +39,11 @@ type cmd struct {
func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.flags.BoolVar(&c.detailed, "detailed", false,
"Provides detailed information about KV store data.")
"Provides a detailed KV space usage breakdown for any KV data that's been stored.")
c.flags.IntVar(&c.depth, "depth", 2,
"The key prefix depth used to breakdown KV store data. Defaults to 2.")
"Must be used with -detailed. The key prefix depth used to breakdown KV store data. Defaults to 2.")
c.flags.StringVar(&c.filter, "filter", "",
"Filter KV keys using this prefix filter.")
"Must be used with -detailed. Limits KV key breakdown using this prefix filter.")
c.flags.StringVar(
&c.format,
"format",

6
website/pages/commands/snapshot/inspect.mdx
View File

@ -109,7 +109,7 @@ more details about snapshot internals.
#### Command Options
- `-detailed` - Optional, provides a key space usage breakdown for any KV data stored in Consul.
- `-depth` - Optional, used with `-detailed` to adjust the grouping level of keys. Defaults to 2.
- `-filter` - Optional, used with `-detailed` to specify a key prefix that excludes keys that don't match.
- `-detailed` - Optional, provides a space usage breakdown for any KV data stored in Consul.
- `-depth` - Must be used with `-detailed`. Used to adjust the grouping level of keys. Defaults to 2.
- `-filter` - Must be used with `-detailed`. Used to specify a key prefix that excludes keys that don't match.
- `-format` - Optional, allows from changing the output to JSON. Parameters accepted are "pretty" and "JSON".