subcommand: add 'Description()' to interface

To set up for future patches in which we'll improve the command-line
reporting for 'git-bundle-server' commands, add a public 'Description()'
function to require each command to include a string description of its
action.

Signed-off-by: Victoria Dye <[email protected]>

Author: vdye

cmd/git-bundle-server/delete.go

@@ -13,6 +13,12 @@ func (Delete) Name() string {
 	return "delete"
 }
 
+func (Delete) Description() string {
+	return `
+Remove the configuration for the given '<route>' and delete its repository
+data.`
+}
+
 func (Delete) run(args []string) error {
 	if len(args) < 1 {
 		return errors.New("usage: git-bundle-server delete <route>")

cmd/git-bundle-server/init.go

@@ -15,6 +15,12 @@ func (Init) Name() string {
 	return "init"
 }
 
+func (Init) Description() string {
+	return `
+Initialize a repository by cloning a bare repo from '<url>', whose bundles
+should be hosted at '<route>'.`
+}
+
 func (Init) run(args []string) error {
 	if len(args) < 2 {
 		// TODO: allow parsing <route> out of <url>

cmd/git-bundle-server/start.go

@@ -14,6 +14,12 @@ func (Start) Name() string {
 	return "start"
 }
 
+func (Start) Description() string {
+	return `
+Start computing bundles and serving content for the repository at the
+specified '<route>'.`
+}
+
 func (Start) run(args []string) error {
 	if len(args) < 1 {
 		return errors.New("usage: git-bundle-server start <route>")

cmd/git-bundle-server/stop.go

@@ -12,6 +12,12 @@ func (Stop) Name() string {
 	return "stop"
 }
 
+func (Stop) Description() string {
+	return `
+Stop computing bundles or serving content for the repository at the
+specified '<route>'.`
+}
+
 func (Stop) run(args []string) error {
 	if len(args) < 1 {
 		return errors.New("usage: git-bundle-server stop <route>")

cmd/git-bundle-server/subcommand.go

@@ -2,6 +2,7 @@ package main
 
 type Subcommand interface {
 	Name() string
+	Description() string
 	run(args []string) error
 }
 

cmd/git-bundle-server/update-all.go

@@ -14,6 +14,11 @@ func (UpdateAll) Name() string {
 	return "update-all"
 }
 
+func (UpdateAll) Description() string {
+	return `
+For every configured route, run 'git-bundle-server update <options> <route>'.`
+}
+
 func (UpdateAll) run(args []string) error {
 	exe, err := os.Executable()
 	if err != nil {

cmd/git-bundle-server/update.go

@@ -14,6 +14,13 @@ func (Update) Name() string {
 	return "update"
 }
 
+func (Update) Description() string {
+	return `
+For the repository in the current directory (or the one specified by
+'<route>'), fetch the latest content from the remote, create a new set of
+bundles, and update the bundle list.`
+}
+
 func (Update) run(args []string) error {
 	if len(args) != 1 {
 		// TODO: allow parsing <route> out of <url>