docs: automatically remove ending punctuation from first line of backend option help string when used for flag usage

See #5538
This commit is contained in:
albertony 2021-08-16 14:50:03 +02:00
parent 8b65c55711
commit 9a17b32b5d
4 changed files with 10 additions and 4 deletions

View file

@ -121,6 +121,7 @@ Set to 0 to keep connections indefinitely.
}, { }, {
Name: "tls_cache_size", Name: "tls_cache_size",
Help: `Size of TLS session cache for all control and data connections. Help: `Size of TLS session cache for all control and data connections.
TLS cache allows to resume TLS sessions and reuse PSK between connections. TLS cache allows to resume TLS sessions and reuse PSK between connections.
Increase if default size is not enough resulting in TLS resumption errors. Increase if default size is not enough resulting in TLS resumption errors.
Enabled by default. Use 0 to disable.`, Enabled by default. Use 0 to disable.`,

View file

@ -42,17 +42,20 @@ func init() {
Options: []fs.Option{{ Options: []fs.Option{{
Name: "api_url", Name: "api_url",
Help: `Sia daemon API URL, like http://sia.daemon.host:9980. Help: `Sia daemon API URL, like http://sia.daemon.host:9980.
Note that siad must run with --disable-api-security to open API port for other hosts (not recommended). Note that siad must run with --disable-api-security to open API port for other hosts (not recommended).
Keep default if Sia daemon runs on localhost.`, Keep default if Sia daemon runs on localhost.`,
Default: "http://127.0.0.1:9980", Default: "http://127.0.0.1:9980",
}, { }, {
Name: "api_password", Name: "api_password",
Help: `Sia Daemon API Password. Help: `Sia Daemon API Password.
Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.`, Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.`,
IsPassword: true, IsPassword: true,
}, { }, {
Name: "user_agent", Name: "user_agent",
Help: `Siad User Agent Help: `Siad User Agent
Sia daemon requires the 'Sia-Agent' user agent by default for security`, Sia daemon requires the 'Sia-Agent' user agent by default for security`,
Default: "Sia-Agent", Default: "Sia-Agent",
Advanced: true, Advanced: true,

View file

@ -523,7 +523,7 @@ func AddBackendFlags() {
if nl := strings.IndexRune(help, '\n'); nl >= 0 { if nl := strings.IndexRune(help, '\n'); nl >= 0 {
help = help[:nl] help = help[:nl]
} }
help = strings.TrimSpace(help) help = strings.TrimRight(strings.TrimSpace(help), ".!?")
if opt.IsPassword { if opt.IsPassword {
help += " (obscured)" help += " (obscured)"
} }

View file

@ -109,12 +109,14 @@ Enter a string value. Press Enter for the default ("").
remote> remote:path remote> remote:path
How to encrypt the filenames. How to encrypt the filenames.
Enter a string value. Press Enter for the default ("standard"). Enter a string value. Press Enter for the default ("standard").
Choose a number from below, or type in your own value Choose a number from below, or type in your own value.
1 / Encrypt the filenames. See the docs for the details. / Encrypt the filenames.
1 | See the docs for the details.
\ "standard" \ "standard"
2 / Very simple filename obfuscation. 2 / Very simple filename obfuscation.
\ "obfuscate" \ "obfuscate"
3 / Don't encrypt the file names. Adds a ".bin" extension only. / Don't encrypt the file names.
3 | Adds a ".bin" extension only.
\ "off" \ "off"
filename_encryption> filename_encryption>
Option to either encrypt directory names or leave them intact. Option to either encrypt directory names or leave them intact.