diff options
author | Michael Muré <batolettre@gmail.com> | 2018-09-10 18:16:16 +0200 |
---|---|---|
committer | Michael Muré <batolettre@gmail.com> | 2018-09-10 18:18:00 +0200 |
commit | 9bb980e9de1ec3764069ae70baf0c2458e7c35a4 (patch) | |
tree | ae6daa547ebcd37fcb93419da0e54d2187f0c667 /doc/md | |
parent | fd21de5632fda2bbc030d34c28e9dfc1403d2497 (diff) | |
download | git-bug-9bb980e9de1ec3764069ae70baf0c2458e7c35a4.tar.gz git-bug-9bb980e9de1ec3764069ae70baf0c2458e7c35a4.zip |
ls: support expressing a query with flags as well
Diffstat (limited to 'doc/md')
-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 |
7 files changed, 30 insertions, 11 deletions
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 |