From 9a17b32b5dfdc4e8a18e764e09f93d8d0e01c1fd Mon Sep 17 00:00:00 2001
From: albertony <12441419+albertony@users.noreply.github.com>
Date: Mon, 16 Aug 2021 14:50:03 +0200
Subject: [PATCH] docs: automatically remove ending punctuation from first line
 of backend option help string when used for flag usage

See #5538
---
 backend/ftp/ftp.go    | 1 +
 backend/sia/sia.go    | 3 +++
 cmd/cmd.go            | 2 +-
 docs/content/crypt.md | 8 +++++---
 4 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/backend/ftp/ftp.go b/backend/ftp/ftp.go
index f7a5992de..69edce1b4 100644
--- a/backend/ftp/ftp.go
+++ b/backend/ftp/ftp.go
@@ -121,6 +121,7 @@ Set to 0 to keep connections indefinitely.
 		}, {
 			Name: "tls_cache_size",
 			Help: `Size of TLS session cache for all control and data 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.
 Enabled by default. Use 0 to disable.`,
diff --git a/backend/sia/sia.go b/backend/sia/sia.go
index 10a14c1b9..749445ebf 100644
--- a/backend/sia/sia.go
+++ b/backend/sia/sia.go
@@ -42,17 +42,20 @@ func init() {
 		Options: []fs.Option{{
 			Name: "api_url",
 			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).
 Keep default if Sia daemon runs on localhost.`,
 			Default: "http://127.0.0.1:9980",
 		}, {
 			Name: "api_password",
 			Help: `Sia Daemon API Password.
+
 Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.`,
 			IsPassword: true,
 		}, {
 			Name: "user_agent",
 			Help: `Siad User Agent
+
 Sia daemon requires the 'Sia-Agent' user agent by default for security`,
 			Default:  "Sia-Agent",
 			Advanced: true,
diff --git a/cmd/cmd.go b/cmd/cmd.go
index 5ce9dbf6a..2de68715a 100644
--- a/cmd/cmd.go
+++ b/cmd/cmd.go
@@ -523,7 +523,7 @@ func AddBackendFlags() {
 				if nl := strings.IndexRune(help, '\n'); nl >= 0 {
 					help = help[:nl]
 				}
-				help = strings.TrimSpace(help)
+				help = strings.TrimRight(strings.TrimSpace(help), ".!?")
 				if opt.IsPassword {
 					help += " (obscured)"
 				}
diff --git a/docs/content/crypt.md b/docs/content/crypt.md
index d73084a84..f78bc59db 100644
--- a/docs/content/crypt.md
+++ b/docs/content/crypt.md
@@ -109,12 +109,14 @@ Enter a string value. Press Enter for the default ("").
 remote> remote:path
 How to encrypt the filenames.
 Enter a string value. Press Enter for the default ("standard").
-Choose a number from below, or type in your own value
- 1 / Encrypt the filenames. See the docs for the details.
+Choose a number from below, or type in your own value.
+   / Encrypt the filenames.
+ 1 | See the docs for the details.
    \ "standard"
  2 / Very simple filename obfuscation.
    \ "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"
 filename_encryption>
 Option to either encrypt directory names or leave them intact.