cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

Stabilize default text and make gen docsgen-cli

Browse Source
This commit is contained in:
Peter Rabbitson 2021-07-08 10:44:13 +02:00
parent c7bb326c78
commit 140a2e0200
10 changed files with 52 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
cli/client.go
View File

@ -1235,6 +1235,7 @@ var clientListRetrievalsCmd = &cli.Command{
Name: "color", Name: "color",
Usage: "use color in display output", Usage: "use color in display output",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.BoolFlag{ &cli.BoolFlag{
Name: "show-failed", Name: "show-failed",
@ -1808,6 +1809,7 @@ var clientListDeals = &cli.Command{
Name: "color", Name: "color",
Usage: "use color in display output", Usage: "use color in display output",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.BoolFlag{ &cli.BoolFlag{
Name: "show-failed", Name: "show-failed",
@ -2338,6 +2340,7 @@ var clientListTransfers = &cli.Command{
Name: "color", Name: "color",
Usage: "use color in display output", Usage: "use color in display output",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.BoolFlag{ &cli.BoolFlag{
Name: "completed", Name: "completed",

1
cmd/lotus-shed/actor.go
View File

@ -268,6 +268,7 @@ var actorControlList = &cli.Command{
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
}, },
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

1
cmd/lotus-storage-miner/actor.go
View File

@ -391,6 +391,7 @@ var actorControlList = &cli.Command{
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
}, },
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

1
cmd/lotus-storage-miner/main.go
View File

@ -84,6 +84,7 @@ func main() {
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.StringFlag{ &cli.StringFlag{
Name: "repo", Name: "repo",

1
cmd/lotus-storage-miner/market.go
View File

@ -756,6 +756,7 @@ var transfersListCmd = &cli.Command{
Name: "color", Name: "color",
Usage: "use color in display output", Usage: "use color in display output",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.BoolFlag{ &cli.BoolFlag{
Name: "completed", Name: "completed",

2
cmd/lotus-storage-miner/sealing.go
View File

@ -40,6 +40,7 @@ var sealingWorkersCmd = &cli.Command{
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
}, },
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
@ -134,6 +135,7 @@ var sealingJobsCmd = &cli.Command{
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.BoolFlag{ &cli.BoolFlag{
Name: "show-ret-done", Name: "show-ret-done",

1
cmd/lotus-storage-miner/sectors.go
View File

@ -165,6 +165,7 @@ var sectorsListCmd = &cli.Command{
Name: "color", Name: "color",
Aliases: []string{"c"}, Aliases: []string{"c"},
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
&cli.BoolFlag{ &cli.BoolFlag{
Name: "fast", Name: "fast",

2
cmd/lotus-storage-miner/storage.go
View File

@ -170,6 +170,7 @@ var storageListCmd = &cli.Command{
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
}, },
Subcommands: []*cli.Command{ Subcommands: []*cli.Command{
@ -484,6 +485,7 @@ var storageListSectorsCmd = &cli.Command{
&cli.BoolFlag{ &cli.BoolFlag{
Name: "color", Name: "color",
Value: cliutil.DefaultColorUse, Value: cliutil.DefaultColorUse,
DefaultText: "depends on output being a TTY",
}, },
}, },
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

16
documentation/en/cli-lotus-miner.md
View File

@ -41,7 +41,7 @@ COMMANDS:
GLOBAL OPTIONS: GLOBAL OPTIONS:
--actor value, -a value specify other actor to check state for (read only) --actor value, -a value specify other actor to check state for (read only)
--color (default: false) --color (default: depends on output being a TTY)
--miner-repo value, --storagerepo value Specify miner repo path. flag(storagerepo) and env(LOTUS_STORAGE_PATH) are DEPRECATION, will REMOVE SOON (default: "~/.lotusminer") [$LOTUS_MINER_PATH, $LOTUS_STORAGE_PATH] --miner-repo value, --storagerepo value Specify miner repo path. flag(storagerepo) and env(LOTUS_STORAGE_PATH) are DEPRECATION, will REMOVE SOON (default: "~/.lotusminer") [$LOTUS_MINER_PATH, $LOTUS_STORAGE_PATH]
--help, -h show help (default: false) --help, -h show help (default: false)
--version, -v print the version (default: false) --version, -v print the version (default: false)
@ -295,7 +295,7 @@ USAGE:
OPTIONS: OPTIONS:
--verbose (default: false) --verbose (default: false)
--color (default: true) --color (default: depends on output being a TTY)
--help, -h show help (default: false) --help, -h show help (default: false)
``` ```
@ -888,7 +888,7 @@ USAGE:
OPTIONS: OPTIONS:
--verbose, -v print verbose transfer details (default: false) --verbose, -v print verbose transfer details (default: false)
--color use color in display output (default: true) --color use color in display output (default: depends on output being a TTY)
--completed show completed data transfers (default: false) --completed show completed data transfers (default: false)
--watch watch deal updates in real-time, rather than a one time list (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false)
--show-failed show failed/cancelled transfers (default: false) --show-failed show failed/cancelled transfers (default: false)
@ -1344,7 +1344,7 @@ USAGE:
OPTIONS: OPTIONS:
--show-removed show removed sectors (default: false) --show-removed show removed sectors (default: false)
--color, -c (default: true) --color, -c (default: depends on output being a TTY)
--fast don't show on-chain info for better performance (default: false) --fast don't show on-chain info for better performance (default: false)
--events display number of events the sector has received (default: false) --events display number of events the sector has received (default: false)
--seal-time display how long it took for the sector to be sealed (default: false) --seal-time display how long it took for the sector to be sealed (default: false)
@ -1739,7 +1739,7 @@ COMMANDS:
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--color (default: false) --color (default: depends on output being a TTY)
--help, -h show help (default: false) --help, -h show help (default: false)
--version, -v print the version (default: false) --version, -v print the version (default: false)
@ -1754,7 +1754,7 @@ USAGE:
lotus-miner storage list sectors [command options] [arguments...] lotus-miner storage list sectors [command options] [arguments...]
OPTIONS: OPTIONS:
--color (default: true) --color (default: depends on output being a TTY)
--help, -h show help (default: false) --help, -h show help (default: false)
``` ```
@ -1816,7 +1816,7 @@ USAGE:
lotus-miner sealing jobs [command options] [arguments...] lotus-miner sealing jobs [command options] [arguments...]
OPTIONS: OPTIONS:
--color (default: false) --color (default: depends on output being a TTY)
--show-ret-done show returned but not consumed calls (default: false) --show-ret-done show returned but not consumed calls (default: false)
--help, -h show help (default: false) --help, -h show help (default: false)
@ -1831,7 +1831,7 @@ USAGE:
lotus-miner sealing workers [command options] [arguments...] lotus-miner sealing workers [command options] [arguments...]
OPTIONS: OPTIONS:
--color (default: false) --color (default: depends on output being a TTY)
--help, -h show help (default: false) --help, -h show help (default: false)
``` ```

6
documentation/en/cli-lotus.md
View File

@ -535,7 +535,7 @@ CATEGORY:
OPTIONS: OPTIONS:
--verbose, -v print verbose deal details (default: false) --verbose, -v print verbose deal details (default: false)
--color use color in display output (default: true) --color use color in display output (default: depends on output being a TTY)
--show-failed show failed/failing deals (default: true) --show-failed show failed/failing deals (default: true)
--completed show completed retrievals (default: false) --completed show completed retrievals (default: false)
--watch watch deal updates in real-time, rather than a one time list (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false)
@ -609,7 +609,7 @@ CATEGORY:
OPTIONS: OPTIONS:
--verbose, -v print verbose deal details (default: false) --verbose, -v print verbose deal details (default: false)
--color use color in display output (default: true) --color use color in display output (default: depends on output being a TTY)
--show-failed show failed/failing deals (default: false) --show-failed show failed/failing deals (default: false)
--watch watch deal updates in real-time, rather than a one time list (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false)
--help, -h show help (default: false) --help, -h show help (default: false)
@ -747,7 +747,7 @@ CATEGORY:
OPTIONS: OPTIONS:
--verbose, -v print verbose transfer details (default: false) --verbose, -v print verbose transfer details (default: false)
--color use color in display output (default: true) --color use color in display output (default: depends on output being a TTY)
--completed show completed data transfers (default: false) --completed show completed data transfers (default: false)
--watch watch deal updates in real-time, rather than a one time list (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false)
--show-failed show failed/cancelled transfers (default: false) --show-failed show failed/cancelled transfers (default: false)