Normalize CLI options to always use two dashes. (#8037)

Consistently use double dashes and fix typos -conf, -data-dir and
-verify.

Applies also to tests running the syncthing binary for consistency.

* Fix mismatched option name --conf in cli subcommand.

According to the source code comments, the cli option flags should
mirror those from the serve subcommand where applicable.  That one is
actually called --config though.

* cli: Fix help text option placeholders.

The urfave/cli package uses the Value field of StringFlag to provide a
default value, not to name the placeholder.  That is instead done with
backticks around some part of the Usage field.

* cli: Add missing --data flag in subcommand help text.

The urfave/cli based option parsing uses a fake flags collection to
generate help texts matching the used global options.  But the --data
option was omitted from it, although it is definitely required when
using --config as well.  Note that it cannot just be ignored, as some
debug stuff actually uses the DB:

syncthing cli --data=/bar --config=/foo debug index dump

This commit is contained in:

André Colomb

2021-11-04 08:42:55 +01:00

committed by

GitHub

parent 1c2e96a5ca

commit 41bfb7a330

9 changed files with 25 additions and 25 deletions

									
										test/util.go
									
		+1
		-1
	
												View File
												
				@@ -542,7 +542,7 @@ func startInstance(t *testing.T, i int) *rc.Process {

					p := rc.NewProcess(addr)

					p.LogTo(log)

					if err := p.Start("../bin/syncthing", "-home", fmt.Sprintf("h%d", i), "-no-browser"); err != nil {

					if err := p.Start("../bin/syncthing", "--home", fmt.Sprintf("h%d", i), "--no-browser"); err != nil {

						t.Fatal(err)

					}

					p.AwaitStartup()