johanels/photoprism
1
0
Fork 0
mirror of https://github.com/photoprism/photoprism.git synced 2025-12-12 00:34:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Signed-off-by: Michael Mayer <michael@photoprism.app>
This commit is contained in:
Michael Mayer
2024-05-19 16:17:16 +02:00
parent 839617064a
commit 6f00545563
3 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
internal/commands/backup.go
View File

@@ -36,7 +36,7 @@ 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",
@@ -44,7 +44,7 @@ var backupFlags = []cli.Flag{
},
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",

6
internal/config/flags.go
View File

@@ -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"),
}}, {

3
pkg/report/markdown.go
View File

@@ -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], "* * *", "\\* \\* \\*")
}
}
}
}