diff options
| author | Michael Muré <batolettre@gmail.com> | 2022-09-10 11:09:19 +0200 |
|---|---|---|
| committer | Michael Muré <batolettre@gmail.com> | 2022-11-20 17:18:09 +0100 |
| commit | acc9a6f3a6df2961c3ae44352216d915cb9b5315 (patch) | |
| tree | e159372673104ade1f15ddc1a84aa9da93e93552 /doc | |
| parent | a3fa445a9c76631c4cd16f93e1c1c68a954adef7 (diff) | |
| download | git-bug-acc9a6f3a6df2961c3ae44352216d915cb9b5315.tar.gz | |
commands: reorg into different packages
Diffstat (limited to 'doc')
86 files changed, 492 insertions, 479 deletions
diff --git a/doc/cli-convention.md b/doc/cli-convention.md new file mode 100644 index 00000000..47eccf69 --- /dev/null +++ b/doc/cli-convention.md @@ -0,0 +1,13 @@ +## Pattern + +CLI commands should consistently follow this pattern: + +``` +xxx --> list xxx things if list, otherwise show one +xxx new --> create thing +xxx rm --> delete thing +xxx show ID --> show one +xxx show --> show one with "select" implied ID +xxx yyy --> action commands for that thing, or subcommand +xxx select|deselect --> select/deselect implied ID +``` diff --git a/doc/man/git-bug-bridge-auth-rm.1 b/doc/man/git-bug-bridge-auth-rm.1 index a22da320..4ce7672c 100644 --- a/doc/man/git-bug-bridge-auth-rm.1 +++ b/doc/man/git-bug-bridge-auth-rm.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-bridge-auth-rm - Remove a credential. +git-bug-bridge-auth-rm - Remove a credential .SH SYNOPSIS .PP -\fBgit-bug bridge auth rm ID [flags]\fP +\fBgit-bug bridge auth rm BRIDGE_ID [flags]\fP .SH DESCRIPTION .PP -Remove a credential. +Remove a credential .SH OPTIONS diff --git a/doc/man/git-bug-bridge-auth-show.1 b/doc/man/git-bug-bridge-auth-show.1 index 19ac9d37..1c4385ff 100644 --- a/doc/man/git-bug-bridge-auth-show.1 +++ b/doc/man/git-bug-bridge-auth-show.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-auth-show - Display an authentication credential. +git-bug-bridge-auth-show - Display an authentication credential .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-auth-show - Display an authentication credential. .SH DESCRIPTION .PP -Display an authentication credential. +Display an authentication credential .SH OPTIONS diff --git a/doc/man/git-bug-bridge-auth.1 b/doc/man/git-bug-bridge-auth.1 index 1fd94f5b..f6f36623 100644 --- a/doc/man/git-bug-bridge-auth.1 +++ b/doc/man/git-bug-bridge-auth.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-auth - List all known bridge authentication credentials. +git-bug-bridge-auth - List all known bridge authentication credentials .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-auth - List all known bridge authentication credentials. .SH DESCRIPTION .PP -List all known bridge authentication credentials. +List all known bridge authentication credentials .SH OPTIONS diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-new.1 index 002d8202..1b0b2f38 100644 --- a/doc/man/git-bug-bridge-configure.1 +++ b/doc/man/git-bug-bridge-new.1 @@ -3,12 +3,12 @@ .SH NAME .PP -git-bug-bridge-configure - Configure a new bridge. +git-bug-bridge-new - Configure a new bridge .SH SYNOPSIS .PP -\fBgit-bug bridge configure [flags]\fP +\fBgit-bug bridge new [flags]\fP .SH DESCRIPTION @@ -69,7 +69,7 @@ Configure a new bridge by passing flags or/and using interactive terminal prompt .PP \fB-h\fP, \fB--help\fP[=false] - help for configure + help for new .SH EXAMPLE @@ -111,7 +111,7 @@ Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 Successfully configured bridge: default # For GitHub -git bug bridge configure \\ +git bug bridge new \\ --name=default \\ --target=github \\ --owner=$(OWNER) \\ @@ -119,13 +119,13 @@ git bug bridge configure \\ --token=$(TOKEN) # For Launchpad -git bug bridge configure \\ +git bug bridge new \\ --name=default \\ --target=launchpad-preview \\ --url=https://bugs.launchpad.net/ubuntu/ # For Gitlab -git bug bridge configure \\ +git bug bridge new \\ --name=default \\ --target=github \\ --url=https://github.com/michaelmure/git-bug \\ diff --git a/doc/man/git-bug-bridge-pull.1 b/doc/man/git-bug-bridge-pull.1 index 0ff1f860..4d39b0d7 100644 --- a/doc/man/git-bug-bridge-pull.1 +++ b/doc/man/git-bug-bridge-pull.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-pull - Pull updates. +git-bug-bridge-pull - Pull updates from a remote bug tracker .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-pull - Pull updates. .SH DESCRIPTION .PP -Pull updates. +Pull updates from a remote bug tracker .SH OPTIONS diff --git a/doc/man/git-bug-bridge-push.1 b/doc/man/git-bug-bridge-push.1 index fa882cf0..9541c527 100644 --- a/doc/man/git-bug-bridge-push.1 +++ b/doc/man/git-bug-bridge-push.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-push - Push updates. +git-bug-bridge-push - Push updates to remote bug tracker .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-push - Push updates. .SH DESCRIPTION .PP -Push updates. +Push updates to remote bug tracker .SH OPTIONS diff --git a/doc/man/git-bug-bridge-rm.1 b/doc/man/git-bug-bridge-rm.1 index 2445e6d8..6010eca8 100644 --- a/doc/man/git-bug-bridge-rm.1 +++ b/doc/man/git-bug-bridge-rm.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-rm - Delete a configured bridge. +git-bug-bridge-rm - Delete a configured bridge .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-rm - Delete a configured bridge. .SH DESCRIPTION .PP -Delete a configured bridge. +Delete a configured bridge .SH OPTIONS diff --git a/doc/man/git-bug-bridge.1 b/doc/man/git-bug-bridge.1 index 30e5f3ed..7fbce2c1 100644 --- a/doc/man/git-bug-bridge.1 +++ b/doc/man/git-bug-bridge.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge - Configure and use bridges to other bug trackers. +git-bug-bridge - List bridges to other bug trackers .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge - Configure and use bridges to other bug trackers. .SH DESCRIPTION .PP -Configure and use bridges to other bug trackers. +List bridges to other bug trackers .SH OPTIONS @@ -24,4 +24,4 @@ Configure and use bridges to other bug trackers. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-bridge-auth(1)\fP, \fBgit-bug-bridge-configure(1)\fP, \fBgit-bug-bridge-pull(1)\fP, \fBgit-bug-bridge-push(1)\fP, \fBgit-bug-bridge-rm(1)\fP +\fBgit-bug(1)\fP, \fBgit-bug-bridge-auth(1)\fP, \fBgit-bug-bridge-new(1)\fP, \fBgit-bug-bridge-pull(1)\fP, \fBgit-bug-bridge-push(1)\fP, \fBgit-bug-bridge-rm(1)\fP diff --git a/doc/man/git-bug-comment-edit.1 b/doc/man/git-bug-bug-comment-edit.1 index 03e6c1cd..5a3d3506 100644 --- a/doc/man/git-bug-comment-edit.1 +++ b/doc/man/git-bug-bug-comment-edit.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-comment-edit - Edit an existing comment on a bug. +git-bug-bug-comment-edit - Edit an existing comment on a bug .SH SYNOPSIS .PP -\fBgit-bug comment edit [COMMENT_ID] [flags]\fP +\fBgit-bug bug comment edit [COMMENT_ID] [flags]\fP .SH DESCRIPTION .PP -Edit an existing comment on a bug. +Edit an existing comment on a bug .SH OPTIONS @@ -36,4 +36,4 @@ Edit an existing comment on a bug. .SH SEE ALSO .PP -\fBgit-bug-comment(1)\fP +\fBgit-bug-bug-comment(1)\fP diff --git a/doc/man/git-bug-comment-add.1 b/doc/man/git-bug-bug-comment-new.1 index 41aec9bb..f2afc933 100644 --- a/doc/man/git-bug-comment-add.1 +++ b/doc/man/git-bug-bug-comment-new.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-comment-add - Add a new comment to a bug. +git-bug-bug-comment-new - Add a new comment to a bug .SH SYNOPSIS .PP -\fBgit-bug comment add [ID] [flags]\fP +\fBgit-bug bug comment new [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Add a new comment to a bug. +Add a new comment to a bug .SH OPTIONS @@ -31,9 +31,9 @@ Add a new comment to a bug. .PP \fB-h\fP, \fB--help\fP[=false] - help for add + help for new .SH SEE ALSO .PP -\fBgit-bug-comment(1)\fP +\fBgit-bug-bug-comment(1)\fP diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-bug-comment.1 index 2939b641..162c4182 100644 --- a/doc/man/git-bug-comment.1 +++ b/doc/man/git-bug-bug-comment.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-comment - Display or add comments to a bug. +git-bug-bug-comment - List a bug's comments .SH SYNOPSIS .PP -\fBgit-bug comment [ID] [flags]\fP +\fBgit-bug bug comment [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Display or add comments to a bug. +List a bug's comments .SH OPTIONS @@ -24,4 +24,4 @@ Display or add comments to a bug. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-comment-add(1)\fP, \fBgit-bug-comment-edit(1)\fP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-comment-edit(1)\fP, \fBgit-bug-bug-comment-new(1)\fP diff --git a/doc/man/git-bug-deselect.1 b/doc/man/git-bug-bug-deselect.1 index 9b630357..fd342245 100644 --- a/doc/man/git-bug-deselect.1 +++ b/doc/man/git-bug-bug-deselect.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-deselect - Clear the implicitly selected bug. +git-bug-bug-deselect - Clear the implicitly selected bug .SH SYNOPSIS .PP -\fBgit-bug deselect [flags]\fP +\fBgit-bug bug deselect [flags]\fP .SH DESCRIPTION .PP -Clear the implicitly selected bug. +Clear the implicitly selected bug .SH OPTIONS @@ -39,4 +39,4 @@ git bug deselect .SH SEE ALSO .PP -\fBgit-bug(1)\fP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-label-add.1 b/doc/man/git-bug-bug-label-new.1 index a8ef3375..aa2b0c65 100644 --- a/doc/man/git-bug-label-add.1 +++ b/doc/man/git-bug-bug-label-new.1 @@ -3,25 +3,25 @@ .SH NAME .PP -git-bug-label-add - Add a label to a bug. +git-bug-bug-label-new - Add a label to a bug .SH SYNOPSIS .PP -\fBgit-bug label add [ID] LABEL... [flags]\fP +\fBgit-bug bug label new [BUG_ID] LABEL... [flags]\fP .SH DESCRIPTION .PP -Add a label to a bug. +Add a label to a bug .SH OPTIONS .PP \fB-h\fP, \fB--help\fP[=false] - help for add + help for new .SH SEE ALSO .PP -\fBgit-bug-label(1)\fP +\fBgit-bug-bug-label(1)\fP diff --git a/doc/man/git-bug-label-rm.1 b/doc/man/git-bug-bug-label-rm.1 index 6b98196b..b204d61f 100644 --- a/doc/man/git-bug-label-rm.1 +++ b/doc/man/git-bug-bug-label-rm.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-label-rm - Remove a label from a bug. +git-bug-bug-label-rm - Remove a label from a bug .SH SYNOPSIS .PP -\fBgit-bug label rm [ID] LABEL... [flags]\fP +\fBgit-bug bug label rm [BUG_ID] LABEL... [flags]\fP .SH DESCRIPTION .PP -Remove a label from a bug. +Remove a label from a bug .SH OPTIONS @@ -24,4 +24,4 @@ Remove a label from a bug. .SH SEE ALSO .PP -\fBgit-bug-label(1)\fP +\fBgit-bug-bug-label(1)\fP diff --git a/doc/man/git-bug-bug-label.1 b/doc/man/git-bug-bug-label.1 new file mode 100644 index 00000000..a98c2285 --- /dev/null +++ b/doc/man/git-bug-bug-label.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-label - Display labels of a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug label [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display labels of a bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for label + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-label-new(1)\fP, \fBgit-bug-bug-label-rm(1)\fP diff --git a/doc/man/git-bug-add.1 b/doc/man/git-bug-bug-new.1 index 39c8fce4..91de2dcc 100644 --- a/doc/man/git-bug-add.1 +++ b/doc/man/git-bug-bug-new.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-add - Create a new bug. +git-bug-bug-new - Create a new bug .SH SYNOPSIS .PP -\fBgit-bug add [flags]\fP +\fBgit-bug bug new [flags]\fP .SH DESCRIPTION .PP -Create a new bug. +Create a new bug .SH OPTIONS @@ -35,9 +35,9 @@ Create a new bug. .PP \fB-h\fP, \fB--help\fP[=false] - help for add + help for new .SH SEE ALSO .PP -\fBgit-bug(1)\fP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-rm.1 b/doc/man/git-bug-bug-rm.1 index 78156f37..ee7ea185 100644 --- a/doc/man/git-bug-rm.1 +++ b/doc/man/git-bug-bug-rm.1 @@ -3,12 +3,12 @@ .SH NAME .PP -git-bug-rm - Remove an existing bug. +git-bug-bug-rm - Remove an existing bug .SH SYNOPSIS .PP -\fBgit-bug rm ID [flags]\fP +\fBgit-bug bug rm BUG_ID [flags]\fP .SH DESCRIPTION @@ -24,4 +24,4 @@ Remove an existing bug in the local repository. Note removing bugs that were imp .SH SEE ALSO .PP -\fBgit-bug(1)\fP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-select.1 b/doc/man/git-bug-bug-select.1 index e94d80b1..d73cd606 100644 --- a/doc/man/git-bug-select.1 +++ b/doc/man/git-bug-bug-select.1 @@ -3,12 +3,12 @@ .SH NAME .PP -git-bug-select - Select a bug for implicit use in future commands. +git-bug-bug-select - Select a bug for implicit use in future commands .SH SYNOPSIS .PP -\fBgit-bug select ID [flags]\fP +\fBgit-bug bug select BUG_ID [flags]\fP .SH DESCRIPTION @@ -47,4 +47,4 @@ git bug status .SH SEE ALSO .PP -\fBgit-bug(1)\fP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-show.1 b/doc/man/git-bug-bug-show.1 index 6abf1b6f..aec83fa3 100644 --- a/doc/man/git-bug-show.1 +++ b/doc/man/git-bug-bug-show.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-show - Display the details of a bug. +git-bug-bug-show - Display the details of a bug .SH SYNOPSIS .PP -\fBgit-bug show [ID] [flags]\fP +\fBgit-bug bug show [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Display the details of a bug. +Display the details of a bug .SH OPTIONS @@ -32,4 +32,4 @@ Display the details of a bug. .SH SEE ALSO .PP -\fBgit-bug(1)\fP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-status-close.1 b/doc/man/git-bug-bug-status-close.1 index 3fcbdc35..edd9f666 100644 --- a/doc/man/git-bug-status-close.1 +++ b/doc/man/git-bug-bug-status-close.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-status-close - Mark a bug as closed. +git-bug-bug-status-close - Mark a bug as closed .SH SYNOPSIS .PP -\fBgit-bug status close [ID] [flags]\fP +\fBgit-bug bug status close [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Mark a bug as closed. +Mark a bug as closed .SH OPTIONS @@ -24,4 +24,4 @@ Mark a bug as closed. .SH SEE ALSO .PP -\fBgit-bug-status(1)\fP +\fBgit-bug-bug-status(1)\fP diff --git a/doc/man/git-bug-status-open.1 b/doc/man/git-bug-bug-status-open.1 index e13f11a3..4c001ada 100644 --- a/doc/man/git-bug-status-open.1 +++ b/doc/man/git-bug-bug-status-open.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-status-open - Mark a bug as open. +git-bug-bug-status-open - Mark a bug as open .SH SYNOPSIS .PP -\fBgit-bug status open [ID] [flags]\fP +\fBgit-bug bug status open [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Mark a bug as open. +Mark a bug as open .SH OPTIONS @@ -24,4 +24,4 @@ Mark a bug as open. .SH SEE ALSO .PP -\fBgit-bug-status(1)\fP +\fBgit-bug-bug-status(1)\fP diff --git a/doc/man/git-bug-status.1 b/doc/man/git-bug-bug-status.1 index e810b673..7abcd1a5 100644 --- a/doc/man/git-bug-status.1 +++ b/doc/man/git-bug-bug-status.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-status - Display or change a bug status. +git-bug-bug-status - Display the status of a bug .SH SYNOPSIS .PP -\fBgit-bug status [ID] [flags]\fP +\fBgit-bug bug status [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Display or change a bug status. +Display the status of a bug .SH OPTIONS @@ -24,4 +24,4 @@ Display or change a bug status. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-status-close(1)\fP, \fBgit-bug-status-open(1)\fP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-status-close(1)\fP, \fBgit-bug-bug-status-open(1)\fP diff --git a/doc/man/git-bug-title-edit.1 b/doc/man/git-bug-bug-title-edit.1 index 5e0fa139..c5e33c7a 100644 --- a/doc/man/git-bug-title-edit.1 +++ b/doc/man/git-bug-bug-title-edit.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-title-edit - Edit a title of a bug. +git-bug-bug-title-edit - Edit a title of a bug .SH SYNOPSIS .PP -\fBgit-bug title edit [ID] [flags]\fP +\fBgit-bug bug title edit [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Edit a title of a bug. +Edit a title of a bug .SH OPTIONS @@ -32,4 +32,4 @@ Edit a title of a bug. .SH SEE ALSO .PP -\fBgit-bug-title(1)\fP +\fBgit-bug-bug-title(1)\fP diff --git a/doc/man/git-bug-title.1 b/doc/man/git-bug-bug-title.1 index 164c0257..94568035 100644 --- a/doc/man/git-bug-title.1 +++ b/doc/man/git-bug-bug-title.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-title - Display or change a title of a bug. +git-bug-bug-title - Display the title of a bug .SH SYNOPSIS .PP -\fBgit-bug title [ID] [flags]\fP +\fBgit-bug bug title [BUG_ID] [flags]\fP .SH DESCRIPTION .PP -Display or change a title of a bug. +Display the title of a bug .SH OPTIONS @@ -24,4 +24,4 @@ Display or change a title of a bug. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-title-edit(1)\fP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-title-edit(1)\fP diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-bug.1 index e58177de..6ee62303 100644 --- a/doc/man/git-bug-ls.1 +++ b/doc/man/git-bug-bug.1 @@ -3,12 +3,12 @@ .SH NAME .PP -git-bug-ls - List bugs. +git-bug-bug - List bugs .SH SYNOPSIS .PP -\fBgit-bug ls [QUERY] [flags]\fP +\fBgit-bug bug [QUERY] [flags]\fP .SH DESCRIPTION @@ -66,7 +66,7 @@ You can pass an additional query to filter and order the list. This query can be .PP \fB-h\fP, \fB--help\fP[=false] - help for ls + help for bug .SH EXAMPLE @@ -75,16 +75,16 @@ You can pass an additional query to filter and order the list. This query can be .nf List open bugs sorted by last edition with a query: -git bug ls status:open sort:edit-desc +git bug status:open sort:edit-desc List closed bugs sorted by creation with flags: -git bug ls --status closed --by creation +git bug --status closed --by creation Do a full text search of all bugs: -git bug ls "foo bar" baz +git bug "foo bar" baz Use queries, flags, and full text search: -git bug ls status:open --by creation "foo bar" baz +git bug status:open --by creation "foo bar" baz .fi @@ -93,4 +93,4 @@ git bug ls status:open --by creation "foo bar" baz .SH SEE ALSO .PP -\fBgit-bug(1)\fP +\fBgit-bug(1)\fP, \fBgit-bug-bug-comment(1)\fP, \fBgit-bug-bug-deselect(1)\fP, \fBgit-bug-bug-label(1)\fP, \fBgit-bug-bug-new(1)\fP, \fBgit-bug-bug-rm(1)\fP, \fBgit-bug-bug-select(1)\fP, \fBgit-bug-bug-show(1)\fP, \fBgit-bug-bug-status(1)\fP, \fBgit-bug-bug-title(1)\fP diff --git a/doc/man/git-bug-label-ls.1 b/doc/man/git-bug-label-ls.1 deleted file mode 100644 index 67ee7dd1..00000000 --- a/doc/man/git-bug-label-ls.1 +++ /dev/null @@ -1,30 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-label-ls - List valid labels. - - -.SH SYNOPSIS -.PP -\fBgit-bug label ls [flags]\fP - - -.SH DESCRIPTION -.PP -List valid labels. - -.PP -Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for ls - - -.SH SEE ALSO -.PP -\fBgit-bug-label(1)\fP diff --git a/doc/man/git-bug-label.1 b/doc/man/git-bug-label.1 index 69a5c217..9de7d2c0 100644 --- a/doc/man/git-bug-label.1 +++ b/doc/man/git-bug-label.1 @@ -3,17 +3,20 @@ .SH NAME .PP -git-bug-label - Display, add or remove labels to/from a bug. +git-bug-label - List valid labels .SH SYNOPSIS .PP -\fBgit-bug label [ID] [flags]\fP +\fBgit-bug label [flags]\fP .SH DESCRIPTION .PP -Display, add or remove labels to/from a bug. +List valid labels. + +.PP +Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. .SH OPTIONS @@ -24,4 +27,4 @@ Display, add or remove labels to/from a bug. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-label-add(1)\fP, \fBgit-bug-label-ls(1)\fP, \fBgit-bug-label-rm(1)\fP +\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-pull.1 b/doc/man/git-bug-pull.1 index f2536b30..62485429 100644 --- a/doc/man/git-bug-pull.1 +++ b/doc/man/git-bug-pull.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-pull - Pull bugs update from a git remote. +git-bug-pull - Pull updates from a git remote .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-pull - Pull bugs update from a git remote. .SH DESCRIPTION .PP -Pull bugs update from a git remote. +Pull updates from a git remote .SH OPTIONS diff --git a/doc/man/git-bug-push.1 b/doc/man/git-bug-push.1 index 2be8d6e2..2f15aacb 100644 --- a/doc/man/git-bug-push.1 +++ b/doc/man/git-bug-push.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-push - Push bugs update to a git remote. +git-bug-push - Push updates to a git remote .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-push - Push bugs update to a git remote. .SH DESCRIPTION .PP -Push bugs update to a git remote. +Push updates to a git remote .SH OPTIONS diff --git a/doc/man/git-bug-termui.1 b/doc/man/git-bug-termui.1 index ac09d2ed..7409c963 100644 --- a/doc/man/git-bug-termui.1 +++ b/doc/man/git-bug-termui.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-termui - Launch the terminal UI. +git-bug-termui - Launch the terminal UI .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-termui - Launch the terminal UI. .SH DESCRIPTION .PP -Launch the terminal UI. +Launch the terminal UI .SH OPTIONS diff --git a/doc/man/git-bug-user-adopt.1 b/doc/man/git-bug-user-adopt.1 index ce4e9fe1..f7f2c895 100644 --- a/doc/man/git-bug-user-adopt.1 +++ b/doc/man/git-bug-user-adopt.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-user-adopt - Adopt an existing identity as your own. +git-bug-user-adopt - Adopt an existing identity as your own .SH SYNOPSIS .PP -\fBgit-bug user adopt USER-ID [flags]\fP +\fBgit-bug user adopt USER_ID [flags]\fP .SH DESCRIPTION .PP -Adopt an existing identity as your own. +Adopt an existing identity as your own .SH OPTIONS diff --git a/doc/man/git-bug-user-ls.1 b/doc/man/git-bug-user-ls.1 deleted file mode 100644 index aff46335..00000000 --- a/doc/man/git-bug-user-ls.1 +++ /dev/null @@ -1,31 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-user-ls - List identities. - - -.SH SYNOPSIS -.PP -\fBgit-bug user ls [flags]\fP - - -.SH DESCRIPTION -.PP -List identities. - - -.SH OPTIONS -.PP -\fB-f\fP, \fB--format\fP="default" - Select the output formatting style. Valid values are [default,json] - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for ls - - -.SH SEE ALSO -.PP -\fBgit-bug-user(1)\fP diff --git a/doc/man/git-bug-user-create.1 b/doc/man/git-bug-user-new.1 index 66c7db58..cdb6f91f 100644 --- a/doc/man/git-bug-user-create.1 +++ b/doc/man/git-bug-user-new.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-user-create - Create a new identity. +git-bug-user-new - Create a new identity .SH SYNOPSIS .PP -\fBgit-bug user create [flags]\fP +\fBgit-bug user new [flags]\fP .SH DESCRIPTION .PP -Create a new identity. +Create a new identity .SH OPTIONS @@ -27,7 +27,7 @@ Create a new identity. .PP \fB-h\fP, \fB--help\fP[=false] - help for create + help for new .PP \fB-n\fP, \fB--name\fP="" diff --git a/doc/man/git-bug-user-user.1 b/doc/man/git-bug-user-user.1 new file mode 100644 index 00000000..f4bf83d8 --- /dev/null +++ b/doc/man/git-bug-user-user.1 @@ -0,0 +1,31 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-user-user - Display a user identity + + +.SH SYNOPSIS +.PP +\fBgit-bug user user show [USER_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display a user identity + + +.SH OPTIONS +.PP +\fB-f\fP, \fB--field\fP="" + Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for user + + +.SH SEE ALSO +.PP +\fBgit-bug-user(1)\fP diff --git a/doc/man/git-bug-user.1 b/doc/man/git-bug-user.1 index 2a613ae2..276d0e43 100644 --- a/doc/man/git-bug-user.1 +++ b/doc/man/git-bug-user.1 @@ -3,23 +3,23 @@ .SH NAME .PP -git-bug-user - Display or change the user identity. +git-bug-user - List identities .SH SYNOPSIS .PP -\fBgit-bug user [USER-ID] [flags]\fP +\fBgit-bug user [flags]\fP .SH DESCRIPTION .PP -Display or change the user identity. +List identities .SH OPTIONS .PP -\fB-f\fP, \fB--field\fP="" - Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] +\fB-f\fP, \fB--format\fP="default" + Select the output formatting style. Valid values are [default,json] .PP \fB-h\fP, \fB--help\fP[=false] @@ -28,4 +28,4 @@ Display or change the user identity. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-user-adopt(1)\fP, \fBgit-bug-user-create(1)\fP, \fBgit-bug-user-ls(1)\fP +\fBgit-bug(1)\fP, \fBgit-bug-user-adopt(1)\fP, \fBgit-bug-user-new(1)\fP, \fBgit-bug-user-user(1)\fP diff --git a/doc/man/git-bug-version.1 b/doc/man/git-bug-version.1 index 311f1d2a..6b688221 100644 --- a/doc/man/git-bug-version.1 +++ b/doc/man/git-bug-version.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-version - Show git-bug version information. +git-bug-version - Show git-bug version information .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-version - Show git-bug version information. .SH DESCRIPTION .PP -Show git-bug version information. +Show git-bug version information .SH OPTIONS diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 0fcfeac2..f6cdcfde 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-webui - Launch the web UI. +git-bug-webui - Launch the web UI .SH SYNOPSIS diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1 index b982c7f4..8b66d312 100644 --- a/doc/man/git-bug.1 +++ b/doc/man/git-bug.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug - A bug tracker embedded in Git. +git-bug - A bug tracker embedded in Git .SH SYNOPSIS @@ -29,4 +29,4 @@ the same git remote you are already using to collaborate with other people. .SH SEE ALSO .PP -\fBgit-bug-add(1)\fP, \fBgit-bug-bridge(1)\fP, \fBgit-bug-commands(1)\fP, \fBgit-bug-comment(1)\fP, \fBgit-bug-deselect(1)\fP, \fBgit-bug-label(1)\fP, \fBgit-bug-ls(1)\fP, \fBgit-bug-pull(1)\fP, \fBgit-bug-push(1)\fP, \fBgit-bug-rm(1)\fP, \fBgit-bug-select(1)\fP, \fBgit-bug-show(1)\fP, \fBgit-bug-status(1)\fP, \fBgit-bug-termui(1)\fP, \fBgit-bug-title(1)\fP, \fBgit-bug-user(1)\fP, \fBgit-bug-version(1)\fP, \fBgit-bug-webui(1)\fP +\fBgit-bug-bridge(1)\fP, \fBgit-bug-bug(1)\fP, \fBgit-bug-commands(1)\fP, \fBgit-bug-label(1)\fP, \fBgit-bug-pull(1)\fP, \fBgit-bug-push(1)\fP, \fBgit-bug-termui(1)\fP, \fBgit-bug-user(1)\fP, \fBgit-bug-version(1)\fP, \fBgit-bug-webui(1)\fP diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md index c47f8484..b311aff5 100644 --- a/doc/md/git-bug.md +++ b/doc/md/git-bug.md @@ -1,6 +1,6 @@ ## git-bug -A bug tracker embedded in Git. +A bug tracker embedded in Git ### Synopsis @@ -24,22 +24,14 @@ git-bug [flags] ### SEE ALSO -* [git-bug add](git-bug_add.md) - Create a new bug. -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers +* [git-bug bug](git-bug_bug.md) - List bugs * [git-bug commands](git-bug_commands.md) - Display available commands. -* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. -* [git-bug deselect](git-bug_deselect.md) - Clear the implicitly selected bug. -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. -* [git-bug ls](git-bug_ls.md) - List bugs. -* [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote. -* [git-bug push](git-bug_push.md) - Push bugs update to a git remote. -* [git-bug rm](git-bug_rm.md) - Remove an existing bug. -* [git-bug select](git-bug_select.md) - Select a bug for implicit use in future commands. -* [git-bug show](git-bug_show.md) - Display the details of a bug. -* [git-bug status](git-bug_status.md) - Display or change a bug status. -* [git-bug termui](git-bug_termui.md) - Launch the terminal UI. -* [git-bug title](git-bug_title.md) - Display or change a title of a bug. -* [git-bug user](git-bug_user.md) - Display or change the user identity. -* [git-bug version](git-bug_version.md) - Show git-bug version information. -* [git-bug webui](git-bug_webui.md) - Launch the web UI. +* [git-bug label](git-bug_label.md) - List valid labels +* [git-bug pull](git-bug_pull.md) - Pull updates from a git remote +* [git-bug push](git-bug_push.md) - Push updates to a git remote +* [git-bug termui](git-bug_termui.md) - Launch the terminal UI +* [git-bug user](git-bug_user.md) - List identities +* [git-bug version](git-bug_version.md) - Show git-bug version information +* [git-bug webui](git-bug_webui.md) - Launch the web UI diff --git a/doc/md/git-bug_bridge.md b/doc/md/git-bug_bridge.md index e8b6e382..c3e239e2 100644 --- a/doc/md/git-bug_bridge.md +++ b/doc/md/git-bug_bridge.md @@ -1,6 +1,6 @@ ## git-bug bridge -Configure and use bridges to other bug trackers. +List bridges to other bug trackers ``` git-bug bridge [flags] @@ -14,10 +14,10 @@ git-bug bridge [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. -* [git-bug bridge configure](git-bug_bridge_configure.md) - Configure a new bridge. -* [git-bug bridge pull](git-bug_bridge_pull.md) - Pull updates. -* [git-bug bridge push](git-bug_bridge_push.md) - Push updates. -* [git-bug bridge rm](git-bug_bridge_rm.md) - Delete a configured bridge. +* [git-bug](git-bug.md) - A bug tracker embedded in Git +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials +* [git-bug bridge new](git-bug_bridge_new.md) - Configure a new bridge +* [git-bug bridge pull](git-bug_bridge_pull.md) - Pull updates from a remote bug tracker +* [git-bug bridge push](git-bug_bridge_push.md) - Push updates to remote bug tracker +* [git-bug bridge rm](git-bug_bridge_rm.md) - Delete a configured bridge diff --git a/doc/md/git-bug_bridge_auth.md b/doc/md/git-bug_bridge_auth.md index bcaf6028..e7404822 100644 --- a/doc/md/git-bug_bridge_auth.md +++ b/doc/md/git-bug_bridge_auth.md @@ -1,6 +1,6 @@ ## git-bug bridge auth -List all known bridge authentication credentials. +List all known bridge authentication credentials ``` git-bug bridge auth [flags] @@ -14,8 +14,8 @@ git-bug bridge auth [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers * [git-bug bridge auth add-token](git-bug_bridge_auth_add-token.md) - Store a new token -* [git-bug bridge auth rm](git-bug_bridge_auth_rm.md) - Remove a credential. -* [git-bug bridge auth show](git-bug_bridge_auth_show.md) - Display an authentication credential. +* [git-bug bridge auth rm](git-bug_bridge_auth_rm.md) - Remove a credential +* [git-bug bridge auth show](git-bug_bridge_auth_show.md) - Display an authentication credential diff --git a/doc/md/git-bug_bridge_auth_add-token.md b/doc/md/git-bug_bridge_auth_add-token.md index faafaf61..3fb33036 100644 --- a/doc/md/git-bug_bridge_auth_add-token.md +++ b/doc/md/git-bug_bridge_auth_add-token.md @@ -17,5 +17,5 @@ git-bug bridge auth add-token [TOKEN] [flags] ### SEE ALSO -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials diff --git a/doc/md/git-bug_bridge_auth_rm.md b/doc/md/git-bug_bridge_auth_rm.md index d890054e..8ae3ad52 100644 --- a/doc/md/git-bug_bridge_auth_rm.md +++ b/doc/md/git-bug_bridge_auth_rm.md @@ -1,9 +1,9 @@ ## git-bug bridge auth rm -Remove a credential. +Remove a credential ``` -git-bug bridge auth rm ID [flags] +git-bug bridge auth rm BRIDGE_ID [flags] ``` ### Options @@ -14,5 +14,5 @@ git-bug bridge auth rm ID [flags] ### SEE ALSO -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials diff --git a/doc/md/git-bug_bridge_auth_show.md b/doc/md/git-bug_bridge_auth_show.md index 18d468db..f73bb876 100644 --- a/doc/md/git-bug_bridge_auth_show.md +++ b/doc/md/git-bug_bridge_auth_show.md @@ -1,6 +1,6 @@ ## git-bug bridge auth show -Display an authentication credential. +Display an authentication credential ``` git-bug bridge auth show [flags] @@ -14,5 +14,5 @@ git-bug bridge auth show [flags] ### SEE ALSO -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials diff --git a/doc/md/git-bug_bridge_configure.md b/doc/md/git-bug_bridge_new.md index e3b4c6bd..81bffd49 100644 --- a/doc/md/git-bug_bridge_configure.md +++ b/doc/md/git-bug_bridge_new.md @@ -1,13 +1,13 @@ -## git-bug bridge configure +## git-bug bridge new -Configure a new bridge. +Configure a new bridge ### Synopsis Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge. ``` -git-bug bridge configure [flags] +git-bug bridge new [flags] ``` ### Examples @@ -47,7 +47,7 @@ Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 Successfully configured bridge: default # For GitHub -git bug bridge configure \ +git bug bridge new \ --name=default \ --target=github \ --owner=$(OWNER) \ @@ -55,13 +55,13 @@ git bug bridge configure \ --token=$(TOKEN) # For Launchpad -git bug bridge configure \ +git bug bridge new \ --name=default \ --target=launchpad-preview \ --url=https://bugs.launchpad.net/ubuntu/ # For Gitlab -git bug bridge configure \ +git bug bridge new \ --name=default \ --target=github \ --url=https://github.com/michaelmure/git-bug \ @@ -82,10 +82,10 @@ git bug bridge configure \ -o, --owner string The owner of the remote repository -p, --project string The name of the remote repository --non-interactive Do not ask for user input - -h, --help help for configure + -h, --help help for new ``` ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_bridge_pull.md b/doc/md/git-bug_bridge_pull.md index b1ce2169..0975010a 100644 --- a/doc/md/git-bug_bridge_pull.md +++ b/doc/md/git-bug_bridge_pull.md @@ -1,6 +1,6 @@ ## git-bug bridge pull -Pull updates. +Pull updates from a remote bug tracker ``` git-bug bridge pull [NAME] [flags] @@ -16,5 +16,5 @@ git-bug bridge pull [NAME] [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_bridge_push.md b/doc/md/git-bug_bridge_push.md index a532a26d..c7e1a86d 100644 --- a/doc/md/git-bug_bridge_push.md +++ b/doc/md/git-bug_bridge_push.md @@ -1,6 +1,6 @@ ## git-bug bridge push -Push updates. +Push updates to remote bug tracker ``` git-bug bridge push [NAME] [flags] @@ -14,5 +14,5 @@ git-bug bridge push [NAME] [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_bridge_rm.md b/doc/md/git-bug_bridge_rm.md index 6d8ff67c..2b3baf71 100644 --- a/doc/md/git-bug_bridge_rm.md +++ b/doc/md/git-bug_bridge_rm.md @@ -1,6 +1,6 @@ ## git-bug bridge rm -Delete a configured bridge. +Delete a configured bridge ``` git-bug bridge rm NAME [flags] @@ -14,5 +14,5 @@ git-bug bridge rm NAME [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_bug.md index 5aec0fbc..c040cd16 100644 --- a/doc/md/git-bug_ls.md +++ b/doc/md/git-bug_bug.md @@ -1,6 +1,6 @@ -## git-bug ls +## git-bug bug -List bugs. +List bugs ### Synopsis @@ -9,23 +9,23 @@ Display a summary of each bugs. You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language, flags, a natural language full text search, or a combination of the aforementioned. ``` -git-bug ls [QUERY] [flags] +git-bug bug [QUERY] [flags] ``` ### Examples ``` List open bugs sorted by last edition with a query: -git bug ls status:open sort:edit-desc +git bug status:open sort:edit-desc List closed bugs sorted by creation with flags: -git bug ls --status closed --by creation +git bug --status closed --by creation Do a full text search of all bugs: -git bug ls "foo bar" baz +git bug "foo bar" baz Use queries, flags, and full text search: -git bug ls status:open --by creation "foo bar" baz +git bug status:open --by creation "foo bar" baz ``` @@ -43,10 +43,19 @@ git bug ls status:open --by creation "foo bar" baz -b, --by string Sort the results by a characteristic. Valid values are [id,creation,edit] (default "creation") -d, --direction string Select the sorting direction. Valid values are [asc,desc] (default "asc") -f, --format string Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode] (default "default") - -h, --help help for ls + -h, --help help for bug ``` ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git +* [git-bug bug comment](git-bug_bug_comment.md) - List a bug's comments +* [git-bug bug deselect](git-bug_bug_deselect.md) - Clear the implicitly selected bug +* [git-bug bug label](git-bug_bug_label.md) - Display labels of a bug +* [git-bug bug new](git-bug_bug_new.md) - Create a new bug +* [git-bug bug rm](git-bug_bug_rm.md) - Remove an existing bug +* [git-bug bug select](git-bug_bug_select.md) - Select a bug for implicit use in future commands +* [git-bug bug show](git-bug_bug_show.md) - Display the details of a bug +* [git-bug bug status](git-bug_bug_status.md) - Display the status of a bug +* [git-bug bug title](git-bug_bug_title.md) - Display the title of a bug diff --git a/doc/md/git-bug_bug_comment.md b/doc/md/git-bug_bug_comment.md new file mode 100644 index 00000000..6d56a873 --- /dev/null +++ b/doc/md/git-bug_bug_comment.md @@ -0,0 +1,20 @@ +## git-bug bug comment + +List a bug's comments + +``` +git-bug bug comment [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for comment +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug comment edit](git-bug_bug_comment_edit.md) - Edit an existing comment on a bug +* [git-bug bug comment new](git-bug_bug_comment_new.md) - Add a new comment to a bug + diff --git a/doc/md/git-bug_comment_edit.md b/doc/md/git-bug_bug_comment_edit.md index 1a53b439..86a0a4e6 100644 --- a/doc/md/git-bug_comment_edit.md +++ b/doc/md/git-bug_bug_comment_edit.md @@ -1,9 +1,9 @@ -## git-bug comment edit +## git-bug bug comment edit -Edit an existing comment on a bug. +Edit an existing comment on a bug ``` -git-bug comment edit [COMMENT_ID] [flags] +git-bug bug comment edit [COMMENT_ID] [flags] ``` ### Options @@ -17,5 +17,5 @@ git-bug comment edit [COMMENT_ID] [flags] ### SEE ALSO -* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. +* [git-bug bug comment](git-bug_bug_comment.md) - List a bug's comments diff --git a/doc/md/git-bug_comment_add.md b/doc/md/git-bug_bug_comment_new.md index 5a199aba..b1ba697b 100644 --- a/doc/md/git-bug_comment_add.md +++ b/doc/md/git-bug_bug_comment_new.md @@ -1,9 +1,9 @@ -## git-bug comment add +## git-bug bug comment new -Add a new comment to a bug. +Add a new comment to a bug ``` -git-bug comment add [ID] [flags] +git-bug bug comment new [BUG_ID] [flags] ``` ### Options @@ -12,10 +12,10 @@ git-bug comment add [ID] [flags] -F, --file string Take the message from the given file. Use - to read the message from the standard input -m, --message string Provide the new message from the command line --non-interactive Do not ask for user input - -h, --help help for add + -h, --help help for new ``` ### SEE ALSO -* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. +* [git-bug bug comment](git-bug_bug_comment.md) - List a bug's comments diff --git a/doc/md/git-bug_deselect.md b/doc/md/git-bug_bug_deselect.md index 51ce5dda..d4136068 100644 --- a/doc/md/git-bug_deselect.md +++ b/doc/md/git-bug_bug_deselect.md @@ -1,9 +1,9 @@ -## git-bug deselect +## git-bug bug deselect -Clear the implicitly selected bug. +Clear the implicitly selected bug ``` -git-bug deselect [flags] +git-bug bug deselect [flags] ``` ### Examples @@ -24,5 +24,5 @@ git bug deselect ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_bug_label.md b/doc/md/git-bug_bug_label.md new file mode 100644 index 00000000..ac5fb985 --- /dev/null +++ b/doc/md/git-bug_bug_label.md @@ -0,0 +1,20 @@ +## git-bug bug label + +Display labels of a bug + +``` +git-bug bug label [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for label +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug label new](git-bug_bug_label_new.md) - Add a label to a bug +* [git-bug bug label rm](git-bug_bug_label_rm.md) - Remove a label from a bug + diff --git a/doc/md/git-bug_bug_label_new.md b/doc/md/git-bug_bug_label_new.md new file mode 100644 index 00000000..ada978dc --- /dev/null +++ b/doc/md/git-bug_bug_label_new.md @@ -0,0 +1,18 @@ +## git-bug bug label new + +Add a label to a bug + +``` +git-bug bug label new [BUG_ID] LABEL... [flags] +``` + +### Options + +``` + -h, --help help for new +``` + +### SEE ALSO + +* [git-bug bug label](git-bug_bug_label.md) - Display labels of a bug + diff --git a/doc/md/git-bug_bug_label_rm.md b/doc/md/git-bug_bug_label_rm.md new file mode 100644 index 00000000..7899b1be --- /dev/null +++ b/doc/md/git-bug_bug_label_rm.md @@ -0,0 +1,18 @@ +## git-bug bug label rm + +Remove a label from a bug + +``` +git-bug bug label rm [BUG_ID] LABEL... [flags] +``` + +### Options + +``` + -h, --help help for rm +``` + +### SEE ALSO + +* [git-bug bug label](git-bug_bug_label.md) - Display labels of a bug + diff --git a/doc/md/git-bug_add.md b/doc/md/git-bug_bug_new.md index 5e748610..4dacc5fd 100644 --- a/doc/md/git-bug_add.md +++ b/doc/md/git-bug_bug_new.md @@ -1,9 +1,9 @@ -## git-bug add +## git-bug bug new -Create a new bug. +Create a new bug ``` -git-bug add [flags] +git-bug bug new [flags] ``` ### Options @@ -13,10 +13,10 @@ git-bug add [flags] -m, --message string Provide a message to describe the issue -F, --file string Take the message from the given file. Use - to read the message from the standard input --non-interactive Do not ask for user input - -h, --help help for add + -h, --help help for new ``` ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_rm.md b/doc/md/git-bug_bug_rm.md index 3b77ce1c..2e77c6ec 100644 --- a/doc/md/git-bug_rm.md +++ b/doc/md/git-bug_bug_rm.md @@ -1,13 +1,13 @@ -## git-bug rm +## git-bug bug rm -Remove an existing bug. +Remove an existing bug ### Synopsis Remove an existing bug in the local repository. Note removing bugs that were imported from bridges will not remove the bug on the remote, and will only remove the local copy of the bug. ``` -git-bug rm ID [flags] +git-bug bug rm BUG_ID [flags] ``` ### Options @@ -18,5 +18,5 @@ git-bug rm ID [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_select.md b/doc/md/git-bug_bug_select.md index b8a71120..d529c544 100644 --- a/doc/md/git-bug_select.md +++ b/doc/md/git-bug_bug_select.md @@ -1,6 +1,6 @@ -## git-bug select +## git-bug bug select -Select a bug for implicit use in future commands. +Select a bug for implicit use in future commands ### Synopsis @@ -15,7 +15,7 @@ The complementary command is "git bug deselect" performing the opposite operatio ``` -git-bug select ID [flags] +git-bug bug select BUG_ID [flags] ``` ### Examples @@ -35,5 +35,5 @@ git bug status ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_show.md b/doc/md/git-bug_bug_show.md index c284fc71..1c7b762f 100644 --- a/doc/md/git-bug_show.md +++ b/doc/md/git-bug_bug_show.md @@ -1,9 +1,9 @@ -## git-bug show +## git-bug bug show -Display the details of a bug. +Display the details of a bug ``` -git-bug show [ID] [flags] +git-bug bug show [BUG_ID] [flags] ``` ### Options @@ -16,5 +16,5 @@ git-bug show [ID] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_bug_status.md b/doc/md/git-bug_bug_status.md new file mode 100644 index 00000000..6e71e458 --- /dev/null +++ b/doc/md/git-bug_bug_status.md @@ -0,0 +1,20 @@ +## git-bug bug status + +Display the status of a bug + +``` +git-bug bug status [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for status +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug status close](git-bug_bug_status_close.md) - Mark a bug as closed +* [git-bug bug status open](git-bug_bug_status_open.md) - Mark a bug as open + diff --git a/doc/md/git-bug_bug_status_close.md b/doc/md/git-bug_bug_status_close.md new file mode 100644 index 00000000..f63fabb5 --- /dev/null +++ b/doc/md/git-bug_bug_status_close.md @@ -0,0 +1,18 @@ +## git-bug bug status close + +Mark a bug as closed + +``` +git-bug bug status close [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for close +``` + +### SEE ALSO + +* [git-bug bug status](git-bug_bug_status.md) - Display the status of a bug + diff --git a/doc/md/git-bug_bug_status_open.md b/doc/md/git-bug_bug_status_open.md new file mode 100644 index 00000000..0899de30 --- /dev/null +++ b/doc/md/git-bug_bug_status_open.md @@ -0,0 +1,18 @@ +## git-bug bug status open + +Mark a bug as open + +``` +git-bug bug status open [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for open +``` + +### SEE ALSO + +* [git-bug bug status](git-bug_bug_status.md) - Display the status of a bug + diff --git a/doc/md/git-bug_bug_title.md b/doc/md/git-bug_bug_title.md new file mode 100644 index 00000000..2650487e --- /dev/null +++ b/doc/md/git-bug_bug_title.md @@ -0,0 +1,19 @@ +## git-bug bug title + +Display the title of a bug + +``` +git-bug bug title [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for title +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug title edit](git-bug_bug_title_edit.md) - Edit a title of a bug + diff --git a/doc/md/git-bug_title_edit.md b/doc/md/git-bug_bug_title_edit.md index ae060680..0a26609d 100644 --- a/doc/md/git-bug_title_edit.md +++ b/doc/md/git-bug_bug_title_edit.md @@ -1,9 +1,9 @@ -## git-bug title edit +## git-bug bug title edit -Edit a title of a bug. +Edit a title of a bug ``` -git-bug title edit [ID] [flags] +git-bug bug title edit [BUG_ID] [flags] ``` ### Options @@ -16,5 +16,5 @@ git-bug title edit [ID] [flags] ### SEE ALSO -* [git-bug title](git-bug_title.md) - Display or change a title of a bug. +* [git-bug bug title](git-bug_bug_title.md) - Display the title of a bug diff --git a/doc/md/git-bug_commands.md b/doc/md/git-bug_commands.md index db1054f8..bce599dd 100644 --- a/doc/md/git-bug_commands.md +++ b/doc/md/git-bug_commands.md @@ -15,5 +15,5 @@ git-bug commands [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md deleted file mode 100644 index 48050a97..00000000 --- a/doc/md/git-bug_comment.md +++ /dev/null @@ -1,20 +0,0 @@ -## git-bug comment - -Display or add comments to a bug. - -``` -git-bug comment [ID] [flags] -``` - -### Options - -``` - -h, --help help for comment -``` - -### SEE ALSO - -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug comment add](git-bug_comment_add.md) - Add a new comment to a bug. -* [git-bug comment edit](git-bug_comment_edit.md) - Edit an existing comment on a bug. - diff --git a/doc/md/git-bug_label.md b/doc/md/git-bug_label.md index caeebe89..969edc16 100644 --- a/doc/md/git-bug_label.md +++ b/doc/md/git-bug_label.md @@ -1,9 +1,15 @@ ## git-bug label -Display, add or remove labels to/from a bug. +List valid labels + +### Synopsis + +List valid labels. + +Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. ``` -git-bug label [ID] [flags] +git-bug label [flags] ``` ### Options @@ -14,8 +20,5 @@ git-bug label [ID] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug label add](git-bug_label_add.md) - Add a label to a bug. -* [git-bug label ls](git-bug_label_ls.md) - List valid labels. -* [git-bug label rm](git-bug_label_rm.md) - Remove a label from a bug. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_label_add.md b/doc/md/git-bug_label_add.md deleted file mode 100644 index c90b45d3..00000000 --- a/doc/md/git-bug_label_add.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug label add - -Add a label to a bug. - -``` -git-bug label add [ID] LABEL... [flags] -``` - -### Options - -``` - -h, --help help for add -``` - -### SEE ALSO - -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. - diff --git a/doc/md/git-bug_label_ls.md b/doc/md/git-bug_label_ls.md deleted file mode 100644 index cda6ebba..00000000 --- a/doc/md/git-bug_label_ls.md +++ /dev/null @@ -1,24 +0,0 @@ -## git-bug label ls - -List valid labels. - -### Synopsis - -List valid labels. - -Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. - -``` -git-bug label ls [flags] -``` - -### Options - -``` - -h, --help help for ls -``` - -### SEE ALSO - -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. - diff --git a/doc/md/git-bug_label_rm.md b/doc/md/git-bug_label_rm.md deleted file mode 100644 index 15982d0e..00000000 --- a/doc/md/git-bug_label_rm.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug label rm - -Remove a label from a bug. - -``` -git-bug label rm [ID] LABEL... [flags] -``` - -### Options - -``` - -h, --help help for rm -``` - -### SEE ALSO - -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. - diff --git a/doc/md/git-bug_pull.md b/doc/md/git-bug_pull.md index 5c1d51b6..28f90959 100644 --- a/doc/md/git-bug_pull.md +++ b/doc/md/git-bug_pull.md @@ -1,6 +1,6 @@ ## git-bug pull -Pull bugs update from a git remote. +Pull updates from a git remote ``` git-bug pull [REMOTE] [flags] @@ -14,5 +14,5 @@ git-bug pull [REMOTE] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_push.md b/doc/md/git-bug_push.md index 18779700..a0213a01 100644 --- a/doc/md/git-bug_push.md +++ b/doc/md/git-bug_push.md @@ -1,6 +1,6 @@ ## git-bug push -Push bugs update to a git remote. +Push updates to a git remote ``` git-bug push [REMOTE] [flags] @@ -14,5 +14,5 @@ git-bug push [REMOTE] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_status.md b/doc/md/git-bug_status.md deleted file mode 100644 index 9eb56c6b..00000000 --- a/doc/md/git-bug_status.md +++ /dev/null @@ -1,20 +0,0 @@ -## git-bug status - -Display or change a bug status. - -``` -git-bug status [ID] [flags] -``` - -### Options - -``` - -h, --help help for status -``` - -### SEE ALSO - -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug status close](git-bug_status_close.md) - Mark a bug as closed. -* [git-bug status open](git-bug_status_open.md) - Mark a bug as open. - diff --git a/doc/md/git-bug_status_close.md b/doc/md/git-bug_status_close.md deleted file mode 100644 index aee72649..00000000 --- a/doc/md/git-bug_status_close.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug status close - -Mark a bug as closed. - -``` -git-bug status close [ID] [flags] -``` - -### Options - -``` - -h, --help help for close -``` - -### SEE ALSO - -* [git-bug status](git-bug_status.md) - Display or change a bug status. - diff --git a/doc/md/git-bug_status_open.md b/doc/md/git-bug_status_open.md deleted file mode 100644 index 332a1d96..00000000 --- a/doc/md/git-bug_status_open.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug status open - -Mark a bug as open. - -``` -git-bug status open [ID] [flags] -``` - -### Options - -``` - -h, --help help for open -``` - -### SEE ALSO - -* [git-bug status](git-bug_status.md) - Display or change a bug status. - diff --git a/doc/md/git-bug_termui.md b/doc/md/git-bug_termui.md index 3da6869e..ccab380c 100644 --- a/doc/md/git-bug_termui.md +++ b/doc/md/git-bug_termui.md @@ -1,6 +1,6 @@ ## git-bug termui -Launch the terminal UI. +Launch the terminal UI ``` git-bug termui [flags] @@ -14,5 +14,5 @@ git-bug termui [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_title.md b/doc/md/git-bug_title.md deleted file mode 100644 index 791fcb75..00000000 --- a/doc/md/git-bug_title.md +++ /dev/null @@ -1,19 +0,0 @@ -## git-bug title - -Display or change a title of a bug. - -``` -git-bug title [ID] [flags] -``` - -### Options - -``` - -h, --help help for title -``` - -### SEE ALSO - -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug title edit](git-bug_title_edit.md) - Edit a title of a bug. - diff --git a/doc/md/git-bug_user.md b/doc/md/git-bug_user.md index 302a1eda..86939705 100644 --- a/doc/md/git-bug_user.md +++ b/doc/md/git-bug_user.md @@ -1,22 +1,22 @@ ## git-bug user -Display or change the user identity. +List identities ``` -git-bug user [USER-ID] [flags] +git-bug user [flags] ``` ### Options ``` - -f, --field string Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] - -h, --help help for user + -f, --format string Select the output formatting style. Valid values are [default,json] (default "default") + -h, --help help for user ``` ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug user adopt](git-bug_user_adopt.md) - Adopt an existing identity as your own. -* [git-bug user create](git-bug_user_create.md) - Create a new identity. -* [git-bug user ls](git-bug_user_ls.md) - List identities. +* [git-bug](git-bug.md) - A bug tracker embedded in Git +* [git-bug user adopt](git-bug_user_adopt.md) - Adopt an existing identity as your own +* [git-bug user new](git-bug_user_new.md) - Create a new identity +* [git-bug user user](git-bug_user_user.md) - Display a user identity diff --git a/doc/md/git-bug_user_adopt.md b/doc/md/git-bug_user_adopt.md index 87d1305f..85a447ca 100644 --- a/doc/md/git-bug_user_adopt.md +++ b/doc/md/git-bug_user_adopt.md @@ -1,9 +1,9 @@ ## git-bug user adopt -Adopt an existing identity as your own. +Adopt an existing identity as your own ``` -git-bug user adopt USER-ID [flags] +git-bug user adopt USER_ID [flags] ``` ### Options @@ -14,5 +14,5 @@ git-bug user adopt USER-ID [flags] ### SEE ALSO -* [git-bug user](git-bug_user.md) - Display or change the user identity. +* [git-bug user](git-bug_user.md) - List identities diff --git a/doc/md/git-bug_user_ls.md b/doc/md/git-bug_user_ls.md deleted file mode 100644 index d86263e3..00000000 --- a/doc/md/git-bug_user_ls.md +++ /dev/null @@ -1,19 +0,0 @@ -## git-bug user ls - -List identities. - -``` -git-bug user ls [flags] -``` - -### Options - -``` - -f, --format string Select the output formatting style. Valid values are [default,json] (default "default") - -h, --help help for ls -``` - -### SEE ALSO - -* [git-bug user](git-bug_user.md) - Display or change the user identity. - diff --git a/doc/md/git-bug_user_create.md b/doc/md/git-bug_user_new.md index 68fc2c0e..f9c5ed41 100644 --- a/doc/md/git-bug_user_create.md +++ b/doc/md/git-bug_user_new.md @@ -1,9 +1,9 @@ -## git-bug user create +## git-bug user new -Create a new identity. +Create a new identity ``` -git-bug user create [flags] +git-bug user new [flags] ``` ### Options @@ -11,12 +11,12 @@ git-bug user create [flags] ``` -a, --avatar string Avatar URL -e, --email string Email of the user - -h, --help help for create + -h, --help help for new -n, --name string Name to identify the user --non-interactive Do not ask for user input ``` ### SEE ALSO -* [git-bug user](git-bug_user.md) - Display or change the user identity. +* [git-bug user](git-bug_user.md) - List identities diff --git a/doc/md/git-bug_user_user.md b/doc/md/git-bug_user_user.md new file mode 100644 index 00000000..b3e6ac9b --- /dev/null +++ b/doc/md/git-bug_user_user.md @@ -0,0 +1,19 @@ +## git-bug user user + +Display a user identity + +``` +git-bug user user show [USER_ID] [flags] +``` + +### Options + +``` + -f, --field string Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] + -h, --help help for user +``` + +### SEE ALSO + +* [git-bug user](git-bug_user.md) - List identities + diff --git a/doc/md/git-bug_version.md b/doc/md/git-bug_version.md index 2d1a16a9..ceba8790 100644 --- a/doc/md/git-bug_version.md +++ b/doc/md/git-bug_version.md @@ -1,6 +1,6 @@ ## git-bug version -Show git-bug version information. +Show git-bug version information ``` git-bug version [flags] @@ -17,5 +17,5 @@ git-bug version [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md index b1c54d3b..c342a9cf 100644 --- a/doc/md/git-bug_webui.md +++ b/doc/md/git-bug_webui.md @@ -1,6 +1,6 @@ ## git-bug webui -Launch the web UI. +Launch the web UI ### Synopsis @@ -29,5 +29,5 @@ git-bug webui [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git |