ls: support expressing a query with flags as well

1 files changed, 46 insertions, 3 deletions

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