Skip to content

Commit cfec37e

Browse files
committed
Documentation update
1 parent 2bc8413 commit cfec37e

10 files changed

+57
-19
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTIN
200200

201201
### Project/Repository Branch
202202

203-
* [ ] `get branch [project id or project path] [flags]`
203+
* [x] `get branch [project id or project path] [flags]`
204204
* [x] `describe branch [branch name] [--project] [flags]`
205205
* [x] `new branch [branch name] [--project] [flags]`
206206
* [x] `delete branch [branch name] [--project]`

docs/gitlabctl_edit_branch.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ gitlabctl edit branch master -p devopsctl/gitlabctl --unprotect
2323
### Options
2424

2525
```
26-
--dev-can-merge Flag if developers can merge to the branch (default true)
27-
--dev-can-push Flag if developers can push to the branch (default true)
26+
--dev-can-merge Used with '--protect'. Flag if developers can merge to the branch
27+
--dev-can-push Used with '--protect'. Flag if developers can push to the branch
2828
-h, --help help for branch
2929
-p, --project string The name or ID of the project
30-
--protect Protect a branch (default true)
31-
--unprotect Remove protection of a branch (default true)
30+
--protect Protect a branch
31+
--unprotect Remove protection of a branch
3232
```
3333

3434
### Options inherited from parent commands

docs/gitlabctl_get.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Get Gitlab resources
1111
```
1212
-h, --help help for get
1313
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
14-
--page int Page of results to retrieve (default 1)
15-
--per-page int The number of results to include per page (default 1)
14+
--page int Page of results to retrieve
15+
--per-page int The number of results to include per page
1616
```
1717

1818
### Options inherited from parent commands
@@ -24,6 +24,7 @@ Get Gitlab resources
2424
### SEE ALSO
2525

2626
* [gitlabctl](gitlabctl.md) - Gitlab command-line interface
27+
* [gitlabctl get branch](gitlabctl_get_branch.md) - List all branches of a repository
2728
* [gitlabctl get groups](gitlabctl_get_groups.md) - List groups and subgroups
2829
* [gitlabctl get members](gitlabctl_get_members.md) - List all members of a group or a project
2930
* [gitlabctl get project-hooks](gitlabctl_get_project-hooks.md) - List all project hooks of a specified project

docs/gitlabctl_get_branch.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## gitlabctl get branch
2+
3+
List all branches of a repository
4+
5+
### Synopsis
6+
7+
List all branches of a repository
8+
9+
```
10+
gitlabctl get branch [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
gitlabctl get branch devopsctl/gitlabctl
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for branch
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--config string config file (default is $HOME/.gitlabctl.yaml)
29+
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
30+
--page int Page of results to retrieve
31+
--per-page int The number of results to include per page
32+
```
33+
34+
### SEE ALSO
35+
36+
* [gitlabctl get](gitlabctl_get.md) - Get Gitlab resources
37+

docs/gitlabctl_get_groups.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ gitlabctl get groups --from-group=GroupX
3838
```
3939
--config string config file (default is $HOME/.gitlabctl.yaml)
4040
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
41-
--page int Page of results to retrieve (default 1)
42-
--per-page int The number of results to include per page (default 1)
41+
--page int Page of results to retrieve
42+
--per-page int The number of results to include per page
4343
```
4444

4545
### SEE ALSO

docs/gitlabctl_get_members.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ gitlabctl get members --from-project Group1/Project1
3434
```
3535
--config string config file (default is $HOME/.gitlabctl.yaml)
3636
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
37-
--page int Page of results to retrieve (default 1)
38-
--per-page int The number of results to include per page (default 1)
37+
--page int Page of results to retrieve
38+
--per-page int The number of results to include per page
3939
```
4040

4141
### SEE ALSO

docs/gitlabctl_get_project-hooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ gitlabctl get project-hooks 23
3131
```
3232
--config string config file (default is $HOME/.gitlabctl.yaml)
3333
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
34-
--page int Page of results to retrieve (default 1)
35-
--per-page int The number of results to include per page (default 1)
34+
--page int Page of results to retrieve
35+
--per-page int The number of results to include per page
3636
```
3737

3838
### SEE ALSO

docs/gitlabctl_get_projects.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ gitlabctl get projects --from-group=Group1
4444
```
4545
--config string config file (default is $HOME/.gitlabctl.yaml)
4646
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
47-
--page int Page of results to retrieve (default 1)
48-
--per-page int The number of results to include per page (default 1)
47+
--page int Page of results to retrieve
48+
--per-page int The number of results to include per page
4949
```
5050

5151
### SEE ALSO

docs/gitlabctl_get_ssh-keys.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ gitlabctl get ssh-keys --user="lebron.james"
3232
```
3333
--config string config file (default is $HOME/.gitlabctl.yaml)
3434
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
35-
--page int Page of results to retrieve (default 1)
36-
--per-page int The number of results to include per page (default 1)
35+
--page int Page of results to retrieve
36+
--per-page int The number of results to include per page
3737
```
3838

3939
### SEE ALSO

docs/gitlabctl_get_users.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ gitlabctl get users --created-after="06/04/2018 22:05"
4949
```
5050
--config string config file (default is $HOME/.gitlabctl.yaml)
5151
-o, --out string Print the command output to the desired format. (json, yaml, simple) (default "simple")
52-
--page int Page of results to retrieve (default 1)
53-
--per-page int The number of results to include per page (default 1)
52+
--page int Page of results to retrieve
53+
--per-page int The number of results to include per page
5454
```
5555

5656
### SEE ALSO

0 commit comments

Comments
 (0)