Merge pull request #1100 from Starnop/supernode-cli-docs

[feature]: add generate doc cmd for supernode
dragonflyoss · Nov 28, 2019 · f8ecf02 · f8ecf02
2 parents 72b98ba + c7ae59b
commit f8ecf02
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 72 deletions.
diff --git a/cmd/dfdaemon/app/gen_doc.go b/cmd/dfdaemon/app/gen_doc.go
diff --git a/cmd/dfdaemon/app/root.go b/cmd/dfdaemon/app/root.go
@@ -27,6 +27,7 @@ import (
 	"github.com/dragonflyoss/Dragonfly/dfdaemon"
 	"github.com/dragonflyoss/Dragonfly/dfdaemon/config"
 	"github.com/dragonflyoss/Dragonfly/dfdaemon/constant"
+	"github.com/dragonflyoss/Dragonfly/pkg/cmd"
 	dferr "github.com/dragonflyoss/Dragonfly/pkg/errortypes"
 	"github.com/dragonflyoss/Dragonfly/pkg/netutils"
 	"github.com/dragonflyoss/Dragonfly/pkg/rate"
@@ -105,6 +106,7 @@ func init() {
 	rf.StringSlice("node", nil, "specify the addresses(host:port) of supernodes that will be passed to dfget.")
 
 	exitOnError(bindRootFlags(viper.GetViper()), "bind root command flags")
+	rootCmd.AddCommand(cmd.NewGenDocCommand("dfdaemon"))
 }
 
 // bindRootFlags binds flags on rootCmd to the given viper instance.

diff --git a/cmd/dfget/app/root.go b/cmd/dfget/app/root.go
@@ -26,6 +26,7 @@ import (
 
 	"github.com/dragonflyoss/Dragonfly/dfget/config"
 	"github.com/dragonflyoss/Dragonfly/dfget/core"
+	"github.com/dragonflyoss/Dragonfly/pkg/cmd"
 	"github.com/dragonflyoss/Dragonfly/pkg/dflog"
 	"github.com/dragonflyoss/Dragonfly/pkg/errortypes"
 	"github.com/dragonflyoss/Dragonfly/pkg/printer"
@@ -67,6 +68,7 @@ var rootCmd = &cobra.Command{
 
 func init() {
 	initFlags()
+	rootCmd.AddCommand(cmd.NewGenDocCommand("dfget"))
 }
 
 // runDfget does some init operations and starts to download.

diff --git a/cmd/supernode/app/root.go b/cmd/supernode/app/root.go
@@ -23,6 +23,7 @@ import (
 	"reflect"
 	"time"
 
+	"github.com/dragonflyoss/Dragonfly/pkg/cmd"
 	"github.com/dragonflyoss/Dragonfly/pkg/dflog"
 	"github.com/dragonflyoss/Dragonfly/pkg/errortypes"
 	"github.com/dragonflyoss/Dragonfly/pkg/fileutils"
@@ -50,9 +51,15 @@ var (
 	supernodeViper = viper.GetViper()
 )
 
+// supernodeDescription is used to describe supernode command in details.
+var supernodeDescription = `SuperNode is a long-running process with two primary responsibilities:
+It's the tracker and scheduler in the P2P network that choose appropriate downloading net-path for each peer.
+It's also a CDN server that caches downloaded data from source to avoid downloading the same files from source repeatedly.`
+
 var rootCmd = &cobra.Command{
-	Use:          "Dragonfly Supernode",
-	Long:         "",
+	Use:          "supernode",
+	Short:        "the central control server of Dragonfly used for scheduling and cdn cache",
+	Long:         supernodeDescription,
 	Args:         cobra.NoArgs,
 	SilenceUsage: true,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -115,6 +122,7 @@ var rootCmd = &cobra.Command{
 
 func init() {
 	setupFlags(rootCmd)
+	rootCmd.AddCommand(cmd.NewGenDocCommand("supernode"))
 }
 
 // setupFlags setups flags for command line.

diff --git a/hack/generate-docs.sh b/hack/generate-docs.sh
@@ -14,9 +14,11 @@ generate-cli-docs(){
     CLI_DOCS_DIR=$(cd "../docs/cli_reference" && pwd)
     DFGET_BIN_PATH=../"${BUILD_PATH}"/dfget
     DFDAEMON_BIN_PATH=../"${BUILD_PATH}"/dfdaemon
+    SUPERNODE_BIN_PATH=../"${BUILD_PATH}"/supernode
 
     ${DFGET_BIN_PATH} gen-doc -p "${CLI_DOCS_DIR}" || return
     ${DFDAEMON_BIN_PATH} gen-doc -p "${CLI_DOCS_DIR}" || return
+    ${SUPERNODE_BIN_PATH} gen-doc -p "${CLI_DOCS_DIR}" || return
     echo "Generate: CLI docs in ${CLI_DOCS_DIR}" 
 }
 

diff --git a/cmd/dfget/app/gen_doc.go → pkg/cmd/gen_doc.go b/cmd/dfget/app/gen_doc.go → pkg/cmd/gen_doc.go
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package app
+package cmd
 
 import (
 	"fmt"
@@ -32,11 +32,11 @@ type GenDocCommand struct {
 	path string
 }
 
-func init() {
+func NewGenDocCommand(name string) *cobra.Command {
 	genDocCommand := &GenDocCommand{}
 	genDocCommand.cmd = &cobra.Command{
 		Use:           "gen-doc",
-		Short:         "Generate Document for dfget command line tool with MarkDown format",
+		Short:         fmt.Sprintf("Generate Document for %s command line tool in MarkDown format", name),
 		Args:          cobra.NoArgs,
 		SilenceErrors: true,
 		SilenceUsage:  true,
@@ -45,7 +45,7 @@ func init() {
 		},
 	}
 	genDocCommand.addFlags()
-	rootCmd.AddCommand(genDocCommand.cmd)
+	return genDocCommand.cmd
 }
 
 // addFlags adds flags for specific command.