Update docs

Author: lunny

cmd/dump_repo.go

@@ -20,7 +20,7 @@ import (
 // CmdDumpRepository represents the available dump repository sub-command.
 var CmdDumpRepository = cli.Command{
 	Name:        "dump-repo",
-	Usage:       "Dump the repository from github/gitlab",
+	Usage:       "Dump the repository from git/github/gitea/gitlab",
 	Description: "This is a command for dumping the repository data.",
 	Action:      runDumpRepository,
 	Flags: []cli.Flag{
@@ -32,12 +32,12 @@ var CmdDumpRepository = cli.Command{
 		cli.StringFlag{
 			Name:  "repo_dir, r",
 			Value: "./data",
-			Usage: "Repository dir path",
+			Usage: "Repository dir path to store the data",
 		},
 		cli.StringFlag{
 			Name:  "clone_addr",
 			Value: "",
-			Usage: "The URL will be clone, currently could be a github or gitlab http/https URL",
+			Usage: "The URL will be clone, currently could be a git/github/gitea/gitlab http/https URL",
 		},
 		cli.StringFlag{
 			Name:  "auth_username",

cmd/restore_repo.go

@@ -28,22 +28,22 @@ var CmdRestoreRepository = cli.Command{
 		cli.StringFlag{
 			Name:  "repo_dir, r",
 			Value: "./data",
-			Usage: "Repository dir path",
+			Usage: "Repository dir path to restore from",
 		},
 		cli.StringFlag{
 			Name:  "owner_name",
 			Value: "",
-			Usage: "The data will be stored on a directory with owner name if not empty",
+			Usage: "Restore destination owner name",
 		},
 		cli.StringFlag{
 			Name:  "repo_name",
 			Value: "",
-			Usage: "The data will be stored on a directory with repository name if not empty",
+			Usage: "Restore destination repository name",
 		},
 		cli.StringFlag{
 			Name:  "units",
 			Value: "",
-			Usage: `Which items will be migrated, one or more units should be separated as comma. 
+			Usage: `Which items will be restored, one or more units should be separated as comma. 
 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments are allowed. Empty means all units.`,
 		},
 	},

docs/content/doc/usage/command-line.en-us.md

@@ -441,3 +441,28 @@ Manage running server operations:
               - `--host value`, `-H value`: Mail server host (defaults to: 127.0.0.1:25)
               - `--send-to value`, `-s value`: Email address(es) to send to
               - `--subject value`, `-S value`: Subject header of sent emails
+
+### dump-repo
+
+Dump-repo dumps repository data from git/github/gitea/gitlab:
+
+- Options:
+  - `--git_service service` : Git service, 1 plain git, 2 github, 3 gitea, 4 gitlab
+  - `--repo_dir dir`, `-r dir`: Repository dir path to store the data 
+  - `--clone_addr addr`: The URL will be clone, currently could be a git/github/gitea/gitlab http/https URL. i.e. https://github.com/lunny/tango.git
+  - `--auth_username lunny`: The username to visit the clone_addr
+  - `--auth_password <password>`: The password to visit the clone_addr
+  - `--auth_token <token>`: The personal token to visit the clone_addr
+  - `--owner_name lunny`: The data will be stored on a directory with owner name if not empty
+  - `--repo_name tango`: The data will be stored on a directory with repository name if not empty
+  - `--units <units>`: Which items will be migrated, one or more units should be separated as comma. wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments are allowed. Empty means all units.
+
+### restore-repo
+
+Restore-repo restore repository data from disk dir:
+
+- Options:
+  - `--repo_dir dir`, `-r dir`: Repository dir path to restore from
+  - `--owner_name lunny`: Restore destination owner name
+  - `--repo_name tango`: Restore destination repository name
+  - `--units <units>`: Which items will be restored, one or more units should be separated as comma. wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments are allowed. Empty means all units.