Merge pull request #32 from AntonioMeireles/betterInlineHelp

improve inline help (& 'en passant' the auto-generated docs)
TheNewNormal · Dec 26, 2015 · b0a2203 · b0a2203
2 parents de70cae + 6f0ec3d
commit b0a2203
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 13 deletions.
diff --git a/documentation/man/corectl-query.1 b/documentation/man/corectl-query.1
@@ -19,7 +19,7 @@ Display information about the running CoreOS instances
 .SH OPTIONS
 .PP
 \fB\-a\fP, \fB\-\-all\fP[=false]
-    display extended information about a running CoreOS instances
+    display extended information about a running CoreOS instance
 
 .PP
 \fB\-i\fP, \fB\-\-ip\fP[=false]

diff --git a/documentation/markdown/corectl_kill.md b/documentation/markdown/corectl_kill.md
@@ -8,7 +8,7 @@ Halts one or more running CoreOS instances
 Halts one or more running CoreOS instances
 
 ```
-corectl kill
+corectl kill [VMids]
 ```
 
 ### Options

diff --git a/documentation/markdown/corectl_load.md b/documentation/markdown/corectl_load.md
@@ -9,7 +9,7 @@ Loads CoreOS instances defined in an instrumentation file (either in TOML, JSON
 VMs are always launched by alphabetical order relative to their names.
 
 ```
-corectl load
+corectl load path/to/yourProfile
 ```
 
 ### Examples

diff --git a/documentation/markdown/corectl_put.md b/documentation/markdown/corectl_put.md
@@ -8,7 +8,7 @@ copy file to inside VM
 copy file to inside VM
 
 ```
-corectl put
+corectl put path/to/file VMid:/file/path/on/destination
 ```
 
 ### Examples

diff --git a/documentation/markdown/corectl_query.md b/documentation/markdown/corectl_query.md
@@ -8,13 +8,13 @@ Display information about the running CoreOS instances
 Display information about the running CoreOS instances
 
 ```
-corectl query
+corectl query [VMids]
 ```
 
 ### Options
 
 ```
-  -a, --all    display extended information about a running CoreOS instances
+  -a, --all    display extended information about a running CoreOS instance
   -i, --ip     displays given instance IP address
   -j, --json   outputs in JSON for easy 3rd party integration
 ```

diff --git a/documentation/markdown/corectl_ssh.md b/documentation/markdown/corectl_ssh.md
@@ -8,7 +8,7 @@ Attach to or run commands inside a running CoreOS instance
 Attach to or run commands inside a running CoreOS instance
 
 ```
-corectl ssh
+corectl ssh VMid ["command1;..."]
 ```
 
 ### Examples

diff --git a/halt.go b/halt.go
@@ -27,7 +27,7 @@ import (
 
 var (
 	killCmd = &cobra.Command{
-		Use:     "kill",
+		Use:     "kill [VMids]",
 		Aliases: []string{"stop", "halt"},
 		Short:   "Halts one or more running CoreOS instances",
 		PreRunE: func(cmd *cobra.Command, args []string) (err error) {

diff --git a/load.go b/load.go
@@ -30,7 +30,7 @@ import (
 
 var (
 	loadFCmd = &cobra.Command{
-		Use:   "load",
+		Use:   "load path/to/yourProfile",
 		Short: "Loads CoreOS instances defined in an instrumentation file.",
 		Long: "Loads CoreOS instances defined in an instrumentation file " +
 			"(either in TOML, JSON or YAML format).\n" + "VMs are always launched " +

diff --git a/ps.go b/ps.go
@@ -38,7 +38,7 @@ var (
 		RunE:    psCommand,
 	}
 	queryCmd = &cobra.Command{
-		Use:     "query",
+		Use:     "query [VMids]",
 		Aliases: []string{"q"},
 		Short:   "Display information about the running CoreOS instances",
 		PreRunE: func(cmd *cobra.Command, args []string) (err error) {
@@ -227,7 +227,7 @@ func init() {
 	queryCmd.Flags().BoolP("json", "j", false,
 		"outputs in JSON for easy 3rd party integration")
 	queryCmd.Flags().BoolP("all", "a", false,
-		"display extended information about a running CoreOS instances")
+		"display extended information about a running CoreOS instance")
 	queryCmd.Flags().BoolP("ip", "i", false,
 		"displays given instance IP address")
 	RootCmd.AddCommand(queryCmd)

diff --git a/ssh.go b/ssh.go
@@ -33,7 +33,7 @@ import (
 
 var (
 	sshCmd = &cobra.Command{
-		Use:     "ssh",
+		Use:     "ssh VMid [\"command1;...\"]",
 		Aliases: []string{"attach"},
 		Short:   "Attach to or run commands inside a running CoreOS instance",
 		PreRunE: func(cmd *cobra.Command, args []string) (err error) {
@@ -49,7 +49,7 @@ var (
   corectl ssh VMid "some commands" // runs 'some commands' inside VMid and exits`,
 	}
 	scpCmd = &cobra.Command{
-		Use:     "put",
+		Use:     "put path/to/file VMid:/file/path/on/destination",
 		Aliases: []string{"copy", "cp", "scp"},
 		Short:   "copy file to inside VM",
 		PreRunE: func(cmd *cobra.Command, args []string) (err error) {