Documentation update

devopsctl · Jun 21, 2018 · cfec37e · cfec37e
1 parent 2bc8413
commit cfec37e
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -200,7 +200,7 @@ Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTIN
 
 ### Project/Repository Branch
 
-* [ ] `get branch [project id or project path] [flags]`
+* [x] `get branch [project id or project path] [flags]`
 * [x] `describe branch [branch name] [--project] [flags]`
 * [x] `new branch [branch name] [--project] [flags]`
 * [x] `delete branch [branch name] [--project]`

diff --git a/docs/gitlabctl_edit_branch.md b/docs/gitlabctl_edit_branch.md
@@ -23,12 +23,12 @@ gitlabctl edit branch master -p devopsctl/gitlabctl --unprotect
 ### Options
 
 ```
-      --dev-can-merge    Flag if developers can merge to the branch (default true)
-      --dev-can-push     Flag if developers can push to the branch (default true)
+      --dev-can-merge    Used with '--protect'. Flag if developers can merge to the branch
+      --dev-can-push     Used with '--protect'. Flag if developers can push to the branch
   -h, --help             help for branch
   -p, --project string   The name or ID of the project
-      --protect          Protect a branch (default true)
-      --unprotect        Remove protection of a branch (default true)
+      --protect          Protect a branch
+      --unprotect        Remove protection of a branch
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/gitlabctl_get.md b/docs/gitlabctl_get.md
@@ -11,8 +11,8 @@ Get Gitlab resources
 ```
   -h, --help           help for get
   -o, --out string     Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int       Page of results to retrieve (default 1)
-      --per-page int   The number of results to include per page (default 1)
+      --page int       Page of results to retrieve
+      --per-page int   The number of results to include per page
 ```
 
 ### Options inherited from parent commands
@@ -24,6 +24,7 @@ Get Gitlab resources
 ### SEE ALSO
 
 * [gitlabctl](gitlabctl.md)	 - Gitlab command-line interface
+* [gitlabctl get branch](gitlabctl_get_branch.md)	 - List all branches of a repository
 * [gitlabctl get groups](gitlabctl_get_groups.md)	 - List groups and subgroups
 * [gitlabctl get members](gitlabctl_get_members.md)	 - List all members of a group or a project
 * [gitlabctl get project-hooks](gitlabctl_get_project-hooks.md)	 - List all project hooks of a specified project

diff --git a/docs/gitlabctl_get_branch.md b/docs/gitlabctl_get_branch.md
@@ -0,0 +1,37 @@
+## gitlabctl get branch
+
+List all branches of a repository
+
+### Synopsis
+
+List all branches of a repository
+
+```
+gitlabctl get branch [flags]
+```
+
+### Examples
+
+```
+gitlabctl get branch devopsctl/gitlabctl
+```
+
+### Options
+
+```
+  -h, --help   help for branch
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.gitlabctl.yaml)
+  -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
+```
+
+### SEE ALSO
+
+* [gitlabctl get](gitlabctl_get.md)	 - Get Gitlab resources
+
diff --git a/docs/gitlabctl_get_groups.md b/docs/gitlabctl_get_groups.md
@@ -38,8 +38,8 @@ gitlabctl get groups --from-group=GroupX
 ```
       --config string   config file (default is $HOME/.gitlabctl.yaml)
   -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int        Page of results to retrieve (default 1)
-      --per-page int    The number of results to include per page (default 1)
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
 ```
 
 ### SEE ALSO

diff --git a/docs/gitlabctl_get_members.md b/docs/gitlabctl_get_members.md
@@ -34,8 +34,8 @@ gitlabctl get members --from-project Group1/Project1
 ```
       --config string   config file (default is $HOME/.gitlabctl.yaml)
   -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int        Page of results to retrieve (default 1)
-      --per-page int    The number of results to include per page (default 1)
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
 ```
 
 ### SEE ALSO

diff --git a/docs/gitlabctl_get_project-hooks.md b/docs/gitlabctl_get_project-hooks.md
@@ -31,8 +31,8 @@ gitlabctl get project-hooks 23
 ```
       --config string   config file (default is $HOME/.gitlabctl.yaml)
   -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int        Page of results to retrieve (default 1)
-      --per-page int    The number of results to include per page (default 1)
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
 ```
 
 ### SEE ALSO

diff --git a/docs/gitlabctl_get_projects.md b/docs/gitlabctl_get_projects.md
@@ -44,8 +44,8 @@ gitlabctl get projects --from-group=Group1
 ```
       --config string   config file (default is $HOME/.gitlabctl.yaml)
   -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int        Page of results to retrieve (default 1)
-      --per-page int    The number of results to include per page (default 1)
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
 ```
 
 ### SEE ALSO

diff --git a/docs/gitlabctl_get_ssh-keys.md b/docs/gitlabctl_get_ssh-keys.md
@@ -32,8 +32,8 @@ gitlabctl get ssh-keys --user="lebron.james"
 ```
       --config string   config file (default is $HOME/.gitlabctl.yaml)
   -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int        Page of results to retrieve (default 1)
-      --per-page int    The number of results to include per page (default 1)
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
 ```
 
 ### SEE ALSO

diff --git a/docs/gitlabctl_get_users.md b/docs/gitlabctl_get_users.md
@@ -49,8 +49,8 @@ gitlabctl get users --created-after="06/04/2018 22:05"
 ```
       --config string   config file (default is $HOME/.gitlabctl.yaml)
   -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
-      --page int        Page of results to retrieve (default 1)
-      --per-page int    The number of results to include per page (default 1)
+      --page int        Page of results to retrieve
+      --per-page int    The number of results to include per page
 ```
 
 ### SEE ALSO