Config: Improve usage descriptions for backup options and flags #4243

Signed-off-by: Michael Mayer <michael@photoprism.app>
photoprism · May 19, 2024 · 6f00545 · 6f00545
1 parent 8396170
commit 6f00545
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/internal/commands/backup.go b/internal/commands/backup.go
@@ -36,15 +36,15 @@ var backupFlags = []cli.Flag{
 	},
 	cli.BoolFlag{
 		Name:  "albums, a",
-		Usage: "create or update album YAML backup files in the album backup path",
+		Usage: "create YAML backup files for album metadata (in the standard backup path if no other path is specified)",
 	},
 	cli.StringFlag{
 		Name:  "albums-path",
 		Usage: "custom album backup `PATH`",
 	},
 	cli.BoolFlag{
 		Name:  "database, index, i",
-		Usage: "create a database backup in the database backup path with the date as filename, or write it to the specified file (stdout if - is passed as filename)",
+		Usage: "create index database backup (in the backup path with the date as filename if no filename is passed, or sent to stdout if - is passed as filename)",
 	},
 	cli.StringFlag{
 		Name:  "database-path, index-path",

diff --git a/internal/config/flags.go b/internal/config/flags.go
@@ -158,7 +158,7 @@ var Flags = CliFlags{
 		}}, {
 		Flag: cli.BoolFlag{
 			Name:   "sidecar-yaml",
-			Usage:  "save originals metadata to YAML sidecar files",
+			Usage:  "create YAML sidecar files to back up index metadata",
 			EnvVar: EnvVar("SIDECAR_YAML"),
 		}, DocDefault: "true"}, {
 		Flag: cli.StringFlag{
@@ -210,7 +210,7 @@ var Flags = CliFlags{
 		}, DocDefault: "true"}, {
 		Flag: cli.BoolFlag{
 			Name:   "backup-albums",
-			Usage:  "save album metadata to YAML backup files",
+			Usage:  "create YAML backup files for album metadata",
 			EnvVar: EnvVar("BACKUP_ALBUMS"),
 		}, DocDefault: "true"}, {
 		Flag: cli.IntFlag{
@@ -221,7 +221,7 @@ var Flags = CliFlags{
 		}}, {
 		Flag: cli.StringFlag{
 			Name:   "index-schedule",
-			Usage:  "regular indexing `SCHEDULE` in cron format (e.g. \"0 */3 * * *\" or \"@every 3h\" for every 3 hours; leave empty to disable)",
+			Usage:  "regular indexing `SCHEDULE` in cron format (e.g. \"@every 3h\" for every 3 hours; \"\" to disable)",
 			Value:  DefaultIndexSchedule,
 			EnvVar: EnvVar("INDEX_SCHEDULE"),
 		}}, {

diff --git a/pkg/report/markdown.go b/pkg/report/markdown.go
@@ -17,6 +17,9 @@ func MarkdownTable(rows [][]string, cols []string, opt Options) string {
 				if strings.ContainsRune(rows[i][j], '|') {
 					rows[i][j] = strings.ReplaceAll(rows[i][j], "|", "\\|")
 				}
+				if strings.ContainsRune(rows[i][j], '*') {
+					rows[i][j] = strings.ReplaceAll(rows[i][j], "* * *", "\\* \\* \\*")
+				}
 			}
 		}
 	}