extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-22 00:13:52 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

main: better descriptions for root subcommands

Browse Source
This commit is contained in:
Christian Schwarz 2018-10-11 17:45:41 +02:00
parent 4e16952ad9
commit 525a875825
1 changed files with 9 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
main.go
View File

@ -14,18 +14,12 @@ import (
var rootCmd = &cobra.Command{ var rootCmd = &cobra.Command{
Use: "zrepl", Use: "zrepl",
Short: "ZFS dataset replication", Short: "One-stop ZFS replication solution",
Long: `Replicate ZFS filesystems & volumes between pools:
- push & pull mode
- automatic snapshot creation & pruning
- local / over the network
- ACLs instead of blank SSH access`,
} }
var daemonCmd = &cobra.Command{ var daemonCmd = &cobra.Command{
Use: "daemon", Use: "daemon",
Short: "daemon", Short: "run the zrepl daemon",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
conf, err := config.ParseConfig(rootArgs.configFile) conf, err := config.ParseConfig(rootArgs.configFile)
if err != nil { if err != nil {
@ -36,8 +30,8 @@ var daemonCmd = &cobra.Command{
} }
var wakeupCmd = &cobra.Command{ var wakeupCmd = &cobra.Command{
Use: "wakeup", Use: "wakeup JOB",
Short: "wake up jobs", Short: "trigger replication and subsequent pruning for a job",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
conf, err := config.ParseConfig(rootArgs.configFile) conf, err := config.ParseConfig(rootArgs.configFile)
if err != nil { if err != nil {
@ -51,7 +45,7 @@ var statusCmdFlags client.StatusFlags
var statusCmd = &cobra.Command{ var statusCmd = &cobra.Command{
Use: "status", Use: "status",
Short: "status", Short: "show job activity or dump as JSON for monitoring",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
conf, err := config.ParseConfig(rootArgs.configFile) conf, err := config.ParseConfig(rootArgs.configFile)
if err != nil { if err != nil {
@ -63,7 +57,7 @@ var statusCmd = &cobra.Command{
var stdinserverCmd = &cobra.Command{ var stdinserverCmd = &cobra.Command{
Use: "stdinserver CLIENT_IDENTITY", Use: "stdinserver CLIENT_IDENTITY",
Short: "start in stdinserver mode (from authorized_keys file)", Short: "stdinserver transport mode (started from authorized_keys file as forced command)",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
conf, err := config.ParseConfig(rootArgs.configFile) conf, err := config.ParseConfig(rootArgs.configFile)
if err != nil { if err != nil {
@ -93,7 +87,7 @@ var bashcompCmd = &cobra.Command{
var configcheckCmd = &cobra.Command{ var configcheckCmd = &cobra.Command{
Use: "configcheck", Use: "configcheck",
Short: "validate config file", Short: "check if config can be parsed without errors",
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
conf, err := config.ParseConfig(rootArgs.configFile) conf, err := config.ParseConfig(rootArgs.configFile)
if err != nil { if err != nil {
@ -106,7 +100,7 @@ var configcheckCmd = &cobra.Command{
var versionCmdArgs client.VersionArgs var versionCmdArgs client.VersionArgs
var versionCmd = &cobra.Command{ var versionCmd = &cobra.Command{
Use: "version", Use: "version",
Short: "print version of zrepl binary (for running daemon 'zrepl control version' command)", Short: "print version of zrepl binary and running daemon",
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
conf, err := config.ParseConfig(rootArgs.configFile) conf, err := config.ParseConfig(rootArgs.configFile)
if err == nil { if err == nil {
@ -160,7 +154,7 @@ func init() {
rootCmd.PersistentFlags().StringVar(&rootArgs.configFile, "config", "", "config file path") rootCmd.PersistentFlags().StringVar(&rootArgs.configFile, "config", "", "config file path")
rootCmd.AddCommand(daemonCmd) rootCmd.AddCommand(daemonCmd)
rootCmd.AddCommand(wakeupCmd) rootCmd.AddCommand(wakeupCmd)
statusCmd.Flags().BoolVar(&statusCmdFlags.Raw, "raw", false, "dump raw response from zrepl daemon") statusCmd.Flags().BoolVar(&statusCmdFlags.Raw, "raw", false, "dump raw status description from zrepl daemon")
rootCmd.AddCommand(statusCmd) rootCmd.AddCommand(statusCmd)
rootCmd.AddCommand(stdinserverCmd) rootCmd.AddCommand(stdinserverCmd)
rootCmd.AddCommand(bashcompCmd) rootCmd.AddCommand(bashcompCmd)