perfect document

Signed-off-by: chentanjun <[email protected]>

Author: tanjunchen

client/client.go

@@ -53,7 +53,7 @@ type TLSConfig struct {
 	ManagerWhiteList string `json:"manager-whitelist,omitempty"`
 }
 
-// NewAPIClient initializes a new API client for the given host
+// NewAPIClient initializes a new API client for the given host.
 func NewAPIClient(host string, tls TLSConfig) (CommonAPIClient, error) {
 	if host == "" {
 		host = defaultHost
@@ -111,7 +111,7 @@ func generateBaseURL(u *url.URL, tls TLSConfig) string {
 	return "http://" + u.Host
 }
 
-// BaseURL returns the base URL of APIClient
+// BaseURL returns the base URL of APIClient.
 func (client *APIClient) BaseURL() string {
 	return client.baseURL
 }

client/preheat_info.go

@@ -22,7 +22,7 @@ import (
 	"github.com/dragonflyoss/Dragonfly/apis/types"
 )
 
-// PreheatInfo get detailed information of a preheat task.
+// PreheatInfo gets detailed information of a preheat task.
 func (client *APIClient) PreheatInfo(ctx context.Context, id string) (*types.PreheatInfo, error) {
 	resp, err := client.get(ctx, "/preheats/"+id, nil, nil)
 	if err != nil {

cmd/dfdaemon/app/gen_doc.go

@@ -58,7 +58,7 @@ func (g *GenDocCommand) addFlags() {
 func (g *GenDocCommand) runGenDoc(args []string) error {
 	if _, err := os.Stat(g.path); err != nil {
 		if os.IsNotExist(err) {
-			return fmt.Errorf("path %s does not exits, please check your gen-doc input flag --path", g.path)
+			return fmt.Errorf("path %s does not exist, please check your gen-doc input flag --path", g.path)
 		}
 		return err
 	}

cmd/dfdaemon/app/init.go

@@ -37,7 +37,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// initDfdaemon sets up running environment for dfdaemon according to the given config
+// initDfdaemon sets up running environment for dfdaemon according to the given config.
 func initDfdaemon(cfg config.Properties) error {
 	// if Options.MaxProcs <= 0, programs run with GOMAXPROCS set to the number of cores available.
 	if cfg.MaxProcs > 0 {
@@ -70,7 +70,7 @@ func initDfdaemon(cfg config.Properties) error {
 	return nil
 }
 
-// initLogger initialize the global logrus logger
+// initLogger initializes the global logrus logger.
 func initLogger(cfg config.Properties) error {
 	current, err := user.Current()
 	if err != nil {
@@ -91,7 +91,7 @@ func initLogger(cfg config.Properties) error {
 	return errors.Wrap(dflog.Init(logrus.StandardLogger(), opts...), "init log")
 }
 
-// cleanLocalRepo checks the files at local periodically, and delete the file when
+// cleanLocalRepo checks the files at local periodically, and deletes the file when
 // it comes to a certain age(counted by the last access time).
 // TODO: what happens if the disk usage comes to high level?
 func cleanLocalRepo(dfpath string) {

cmd/dfdaemon/app/root.go

@@ -100,7 +100,7 @@ func init() {
 	exitOnError(bindRootFlags(viper.GetViper()), "bind root command flags")
 }
 
-// bindRootFlags binds flags on rootCmd to the given viper instance
+// bindRootFlags binds flags on rootCmd to the given viper instance.
 func bindRootFlags(v *viper.Viper) error {
 	if err := v.BindPFlags(rootCmd.Flags()); err != nil {
 		return err
@@ -133,7 +133,7 @@ func exitOnError(err error, msg string) {
 	}
 }
 
-// Execute runs dfdaemon
+// Execute runs dfdaemon.
 func Execute() {
 	if err := rootCmd.Execute(); err != nil {
 		logrus.Errorf("dfdaemon failed: %v", err)
@@ -145,7 +145,7 @@ func Execute() {
 	}
 }
 
-// getConfigFromViper returns dfdaemon config from the given viper instance
+// getConfigFromViper returns dfdaemon config from the given viper instance.
 func getConfigFromViper(v *viper.Viper) (*config.Properties, error) {
 	var cfg config.Properties
 	if err := v.Unmarshal(&cfg, func(dc *mapstructure.DecoderConfig) {
@@ -164,7 +164,7 @@ func getConfigFromViper(v *viper.Viper) (*config.Properties, error) {
 }
 
 // decodeWithYAML returns a mapstructure.DecodeHookFunc to decode the given
-// types by unmarshalling from yaml text
+// types by unmarshalling from yaml text.
 func decodeWithYAML(types ...reflect.Type) mapstructure.DecodeHookFunc {
 	return func(f, t reflect.Type, data interface{}) (interface{}, error) {
 		for _, typ := range types {

cmd/dfget/app/gen_doc.go

@@ -59,7 +59,7 @@ func (g *GenDocCommand) runGenDoc(args []string) error {
 	// FIXME: make document path configurable
 	if _, err := os.Stat(g.path); err != nil {
 		if os.IsNotExist(err) {
-			return fmt.Errorf("path %s does not exits, please check your gen-doc input flag --path", g.path)
+			return fmt.Errorf("path %s does not exist, please check your gen-doc input flag --path", g.path)
 		}
 		return err
 	}

cmd/dfget/app/root.go

@@ -62,7 +62,7 @@ func init() {
 	initFlags()
 }
 
-// runDfget do some init operations and start to download.
+// runDfget does some init operations and starts to download.
 func runDfget() error {
 	// initialize logger
 	if err := initClientLog(); err != nil {
@@ -104,7 +104,7 @@ func checkParameters() error {
 	return nil
 }
 
-// load config from property files.
+// initProperties loads config from property files.
 func initProperties() {
 	properties := config.NewProperties()
 	for _, v := range cfg.ConfigFiles {
@@ -151,7 +151,7 @@ func initClientLog() error {
 		dflog.WithDebug(cfg.Verbose),
 	}
 
-	// once cfg.Console is set, process should also output log to console
+	// Once cfg.Console is set, process should also output log to console.
 	if cfg.Console {
 		opts = append(opts, dflog.WithConsole())
 	}

cmd/dfget/app/server.go

@@ -88,7 +88,7 @@ func initServerLog() error {
 		dflog.WithDebug(cfg.Verbose),
 	}
 
-	// once cfg.Console is set, process should also output log to console
+	// Once cfg.Console is set, process should also output log to console.
 	if cfg.Console {
 		opts = append(opts, dflog.WithConsole())
 	}

cmd/supernode/app/root.go

@@ -191,7 +191,7 @@ func initLog(logger *logrus.Logger, logPath string) error {
 	return nil
 }
 
-// initConfig load configuration from config file.
+// initConfig loads configuration from config file.
 // The properties in config file will be covered by the value that comes from
 // command line parameters.
 func initConfig() error {