From 53d6385efa16e50f23c0b5b66b707ccecfc90445 Mon Sep 17 00:00:00 2001
From: "Lei,Liu" <liulei01@qiniu.com>
Date: Fri, 29 May 2020 10:50:15 +0800
Subject: [PATCH] Add usage for some commands

---
 cmd/clear.go   | 12 +++++++-----
 cmd/cover.go   | 13 ++++++++++++-
 cmd/profile.go | 14 ++++++++++++++
 cmd/root.go    |  5 +++++
 cmd/server.go  | 11 +++++++++++
 5 files changed, 49 insertions(+), 6 deletions(-)

diff --git a/cmd/clear.go b/cmd/clear.go
index a266b61..10dba7d 100644
--- a/cmd/clear.go
+++ b/cmd/clear.go
@@ -28,12 +28,14 @@ import (
 var clearCmd = &cobra.Command{
 	Use:   "clear",
 	Short: "Clear code coverage counters of all the registered services",
-	Long: `Clear code coverage counters for the services under test at runtime.
-
-Examples:
-# clear coverage counter by special service url
-goc clear --center=http://127.0.0.1:7777`,
+	Long:  `Clear code coverage counters for the services under test at runtime.`,
+	Example: `
+# Clear coverage counter from default register center http://127.0.0.1:7777.
+goc clear
 
+# Clear coverage counter from specified register center.
+goc clear --center=http://192.168.1.1:8080
+`,
 	Run: func(cmd *cobra.Command, args []string) {
 		res, err := cover.NewWorker().Clear(center)
 		if err != nil {
diff --git a/cmd/cover.go b/cmd/cover.go
index 7381eff..94d992b 100644
--- a/cmd/cover.go
+++ b/cmd/cover.go
@@ -28,7 +28,18 @@ import (
 
 var coverCmd = &cobra.Command{
 	Use:   "cover",
-	Short: "do cover for the target source ",
+	Short: "Do cover for the target source",
+	Long:  `Do cover for the target source. You can select different cover mode (set, count, atomic), default: count`,
+	Example: `
+# Do cover for the current path, default center: http://127.0.0.1:7777,  default cover mode: count.
+goc cover
+
+# Do cover for the current path, default cover mode: count.
+goc cover --center=http://127.0.0.1:7777
+
+# Do cover for the target path,  cover mode: atomic.
+goc cover --center=http://127.0.0.1:7777 --target=/path/to/target --mode=atomic
+`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if mode == "" {
 			log.Fatalf("Error: flag needs an argument: -mode %v", mode)
diff --git a/cmd/profile.go b/cmd/profile.go
index 5fe0759..d130abc 100644
--- a/cmd/profile.go
+++ b/cmd/profile.go
@@ -30,6 +30,20 @@ import (
 var profileCmd = &cobra.Command{
 	Use:   "profile",
 	Short: "Get coverage profile from service registry center",
+	Long:  `Get code coverage profile for the services under test at runtime.`,
+	Example: `
+# Get coverage counter from default register center http://127.0.0.1:7777, the result output to stdout.
+goc profile
+
+# Get coverage counter from default register center, the result output to specified file.
+goc profile -o ./coverage.cov
+
+# Get coverage counter from specified register center, the result output to specified file.
+goc profile --center=http://192.168.1.1:8080 -o ./coverage.cov
+
+# Get coverage counter from specified register center, the result output to specified file.
+goc profile --center=http://192.168.1.1:8080 --output=./coverage.cov
+`,
 	Run: func(cmd *cobra.Command, args []string) {
 		res, err := cover.NewWorker().Profile(center)
 		if err != nil {
diff --git a/cmd/root.go b/cmd/root.go
index eb472f8..37fcc98 100644
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -25,6 +25,11 @@ import (
 var rootCmd = &cobra.Command{
 	Use:   "goc",
 	Short: "goc is a comprehensive coverage testing tool for go language",
+	Long: `goc is a comprehensive coverage testing tool for go language.
+
+Find more information at:
+ https://github.com/qbox/goc
+`,
 }
 
 // Execute the goc tool
diff --git a/cmd/server.go b/cmd/server.go
index 85ec01b..16e0d33 100644
--- a/cmd/server.go
+++ b/cmd/server.go
@@ -24,6 +24,17 @@ import (
 var serverCmd = &cobra.Command{
 	Use:   "server",
 	Short: "Start a service registry center",
+	Long:  `Start a service registry center.`,
+	Example: `
+# Start a service registry center, default port :7777.
+goc server
+
+# Start a service registry center with port :8080.
+goc server --port=:8080
+
+# Start a service registry center with localhost:8080.
+goc server --port=localhost:8080
+`,
 	Run: func(cmd *cobra.Command, args []string) {
 		cover.StartServer(port)
 	},