From 99a55954081975505789bb6439dab9dd44bb4b18 Mon Sep 17 00:00:00 2001 From: JonRB <4564448+eeyrjmr@users.noreply.github.com> Date: Sun, 3 Sep 2023 19:44:01 +0100 Subject: [PATCH] clarify aspects of the dump command (#26887) clarify aspects of the dump command Possibly closes #26862 --------- Co-authored-by: delvh --- cmd/dump.go | 2 +- docs/content/administration/command-line.en-us.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/dump.go b/cmd/dump.go index 9b5259b86..97f292ae0 100644 --- a/cmd/dump.go +++ b/cmd/dump.go @@ -128,7 +128,7 @@ It can be used for backup and capture Gitea server image to send to maintainer`, &cli.StringFlag{ Name: "database", Aliases: []string{"d"}, - Usage: "Specify the database SQL syntax", + Usage: "Specify the database SQL syntax: sqlite3, mysql, mssql, postgres", }, &cli.BoolFlag{ Name: "skip-repository", diff --git a/docs/content/administration/command-line.en-us.md b/docs/content/administration/command-line.en-us.md index 05caff90e..a52b93d34 100644 --- a/docs/content/administration/command-line.en-us.md +++ b/docs/content/administration/command-line.en-us.md @@ -334,9 +334,9 @@ in the current directory. - `--skip-attachment-data`: Skip dumping of attachment data. Optional. - `--skip-package-data`: Skip dumping of package data. Optional. - `--skip-log`: Skip dumping of log data. Optional. - - `--database`, `-d`: Specify the database SQL syntax. Optional. + - `--database`, `-d`: Specify the database SQL syntax. Optional (supported arguments: sqlite3, mysql, mssql, postgres). - `--verbose`, `-V`: If provided, shows additional details. Optional. - - `--type`: Set the dump output format. Optional. (default: zip) + - `--type`: Set the dump output format. Optional. (formats: zip, tar, tar.sz, tar.gz, tar.xz, tar.bz2, tar.br, tar.lz4, tar.zst default: zip). - Examples: - `gitea dump` - `gitea dump --verbose`