diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/git-bug-commands.1 | 8 | ||||
-rw-r--r-- | doc/man/git-bug-comment.1 | 8 | ||||
-rw-r--r-- | doc/man/git-bug-label.1 | 8 | ||||
-rw-r--r-- | doc/man/git-bug-ls.1 | 49 | ||||
-rw-r--r-- | doc/man/git-bug-new.1 | 16 | ||||
-rw-r--r-- | doc/man/git-bug-webui.1 | 8 | ||||
-rw-r--r-- | doc/md/git-bug.md | 2 | ||||
-rw-r--r-- | doc/md/git-bug_commands.md | 2 | ||||
-rw-r--r-- | doc/md/git-bug_comment.md | 2 | ||||
-rw-r--r-- | doc/md/git-bug_label.md | 2 | ||||
-rw-r--r-- | doc/md/git-bug_ls.md | 27 | ||||
-rw-r--r-- | doc/md/git-bug_new.md | 4 | ||||
-rw-r--r-- | doc/md/git-bug_webui.md | 2 |
13 files changed, 100 insertions, 38 deletions
diff --git a/doc/man/git-bug-commands.1 b/doc/man/git-bug-commands.1 index 871e0932..10927df4 100644 --- a/doc/man/git-bug-commands.1 +++ b/doc/man/git-bug-commands.1 @@ -20,13 +20,13 @@ Display available commands .SH OPTIONS .PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for commands - -.PP \fB\-p\fP, \fB\-\-pretty\fP[=false] Output the command description as well as Markdown compatible comment +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for commands + .SH SEE ALSO .PP diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-comment.1 index da2cfa24..7e172d6b 100644 --- a/doc/man/git-bug-comment.1 +++ b/doc/man/git-bug-comment.1 @@ -24,13 +24,13 @@ Add a new comment to a bug Take the message from the given file. Use \- to read the message from the standard input .PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for comment - -.PP \fB\-m\fP, \fB\-\-message\fP="" Provide the new message from the command line +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for comment + .SH SEE ALSO .PP diff --git a/doc/man/git-bug-label.1 b/doc/man/git-bug-label.1 index 6f50dd10..a1b3ea89 100644 --- a/doc/man/git-bug-label.1 +++ b/doc/man/git-bug-label.1 @@ -20,13 +20,13 @@ Manipulate bug's label .SH OPTIONS .PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for label - -.PP \fB\-r\fP, \fB\-\-remove\fP[=false] Remove a label +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for label + .SH SEE ALSO .PP diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-ls.1 index 2f54503f..c5f989a8 100644 --- a/doc/man/git-bug-ls.1 +++ b/doc/man/git-bug-ls.1 @@ -5,25 +5,68 @@ .SH NAME .PP -git\-bug\-ls \- Display a summary of all bugs +git\-bug\-ls \- List bugs .SH SYNOPSIS .PP -\fBgit\-bug ls <query> [flags]\fP +\fBgit\-bug ls [<query>] [flags]\fP .SH DESCRIPTION .PP -Display a summary of all bugs +Display a summary of each bugs. + +.PP +You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language or with flags. .SH OPTIONS .PP +\fB\-s\fP, \fB\-\-status\fP=[] + Filter by status. Valid values are [open,closed] + +.PP +\fB\-a\fP, \fB\-\-author\fP=[] + Filter by author + +.PP +\fB\-l\fP, \fB\-\-label\fP=[] + Filter by label + +.PP +\fB\-n\fP, \fB\-\-no\fP=[] + Filter by absence of something. Valid values are [label] + +.PP +\fB\-b\fP, \fB\-\-by\fP="creation" + Sort the results by a characteristic. Valid values are [id,creation,edit] + +.PP +\fB\-d\fP, \fB\-\-direction\fP="asc" + Select the sorting direction. Valid values are [asc,desc] + +.PP \fB\-h\fP, \fB\-\-help\fP[=false] help for ls +.SH EXAMPLE +.PP +.RS + +.nf +List open bugs sorted by last edition with a query: +git bug ls "status:open sort:edit\-desc" + +List closed bugs sorted by creation with flags: +git bug ls \-\-status closed \-\-by creation + + +.fi +.RE + + .SH SEE ALSO .PP \fBgit\-bug(1)\fP diff --git a/doc/man/git-bug-new.1 b/doc/man/git-bug-new.1 index b0f0ae8b..f963ea57 100644 --- a/doc/man/git-bug-new.1 +++ b/doc/man/git-bug-new.1 @@ -20,20 +20,20 @@ Create a new bug .SH OPTIONS .PP -\fB\-F\fP, \fB\-\-file\fP="" - Take the message from the given file. Use \- to read the message from the standard input - -.PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for new +\fB\-t\fP, \fB\-\-title\fP="" + Provide a title to describe the issue .PP \fB\-m\fP, \fB\-\-message\fP="" Provide a message to describe the issue .PP -\fB\-t\fP, \fB\-\-title\fP="" - Provide a title to describe the issue +\fB\-F\fP, \fB\-\-file\fP="" + Take the message from the given file. Use \- to read the message from the standard input + +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for new .SH SEE ALSO diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 519a9158..9b0ac769 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -20,13 +20,13 @@ Launch the web UI .SH OPTIONS .PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for webui - -.PP \fB\-p\fP, \fB\-\-port\fP=0 Port to listen to +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for webui + .SH SEE ALSO .PP diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md index 1e97e74e..6131ed2c 100644 --- a/doc/md/git-bug.md +++ b/doc/md/git-bug.md @@ -24,7 +24,7 @@ git-bug [flags] * [git-bug commands](git-bug_commands.md) - Display available commands * [git-bug comment](git-bug_comment.md) - Add a new comment to a bug * [git-bug label](git-bug_label.md) - Manipulate bug's label -* [git-bug ls](git-bug_ls.md) - Display a summary of all bugs +* [git-bug ls](git-bug_ls.md) - List bugs * [git-bug new](git-bug_new.md) - Create a new bug * [git-bug open](git-bug_open.md) - Mark the bug as open * [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote diff --git a/doc/md/git-bug_commands.md b/doc/md/git-bug_commands.md index 2ca62eab..a653d523 100644 --- a/doc/md/git-bug_commands.md +++ b/doc/md/git-bug_commands.md @@ -13,8 +13,8 @@ git-bug commands [<option>...] [flags] ### Options ``` - -h, --help help for commands -p, --pretty Output the command description as well as Markdown compatible comment + -h, --help help for commands ``` ### SEE ALSO diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md index 87541f8a..8616c511 100644 --- a/doc/md/git-bug_comment.md +++ b/doc/md/git-bug_comment.md @@ -14,8 +14,8 @@ git-bug comment <id> [flags] ``` -F, --file string Take the message from the given file. Use - to read the message from the standard input - -h, --help help for comment -m, --message string Provide the new message from the command line + -h, --help help for comment ``` ### SEE ALSO diff --git a/doc/md/git-bug_label.md b/doc/md/git-bug_label.md index 16efe4ed..eff99f16 100644 --- a/doc/md/git-bug_label.md +++ b/doc/md/git-bug_label.md @@ -13,8 +13,8 @@ git-bug label <id> [<label>...] [flags] ### Options ``` - -h, --help help for label -r, --remove Remove a label + -h, --help help for label ``` ### SEE ALSO diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_ls.md index 5b89fabb..53f9b7f4 100644 --- a/doc/md/git-bug_ls.md +++ b/doc/md/git-bug_ls.md @@ -1,19 +1,38 @@ ## git-bug ls -Display a summary of all bugs +List bugs ### Synopsis -Display a summary of all bugs +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 or with flags. + +``` +git-bug ls [<query>] [flags] ``` -git-bug ls <query> [flags] + +### Examples + +``` +List open bugs sorted by last edition with a query: +git bug ls "status:open sort:edit-desc" + +List closed bugs sorted by creation with flags: +git bug ls --status closed --by creation + ``` ### Options ``` - -h, --help help for ls + -s, --status strings Filter by status. Valid values are [open,closed] + -a, --author strings Filter by author + -l, --label strings Filter by label + -n, --no strings Filter by absence of something. Valid values are [label] + -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") + -h, --help help for ls ``` ### SEE ALSO diff --git a/doc/md/git-bug_new.md b/doc/md/git-bug_new.md index c04e944d..de6cffbf 100644 --- a/doc/md/git-bug_new.md +++ b/doc/md/git-bug_new.md @@ -13,10 +13,10 @@ git-bug new [flags] ### Options ``` + -t, --title string Provide a title to describe the issue + -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 -h, --help help for new - -m, --message string Provide a message to describe the issue - -t, --title string Provide a title to describe the issue ``` ### SEE ALSO diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md index 52192260..83c88a26 100644 --- a/doc/md/git-bug_webui.md +++ b/doc/md/git-bug_webui.md @@ -13,8 +13,8 @@ git-bug webui [flags] ### Options ``` - -h, --help help for webui -p, --port int Port to listen to + -h, --help help for webui ``` ### SEE ALSO |