aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-09-10 18:16:16 +0200
committerMichael Muré <batolettre@gmail.com>2018-09-10 18:18:00 +0200
commit9bb980e9de1ec3764069ae70baf0c2458e7c35a4 (patch)
treeae6daa547ebcd37fcb93419da0e54d2187f0c667 /doc/man
parentfd21de5632fda2bbc030d34c28e9dfc1403d2497 (diff)
downloadgit-bug-9bb980e9de1ec3764069ae70baf0c2458e7c35a4.tar.gz
ls: support expressing a query with flags as well
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/git-bug-commands.18
-rw-r--r--doc/man/git-bug-comment.18
-rw-r--r--doc/man/git-bug-label.18
-rw-r--r--doc/man/git-bug-ls.149
-rw-r--r--doc/man/git-bug-new.116
-rw-r--r--doc/man/git-bug-webui.18
6 files changed, 70 insertions, 27 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