Update docs for full text search

Mike Goldin created 5 years ago

Change summary

README.md            | 5 +++++
commands/ls.go       | 8 +++++++-
doc/man/git-bug-ls.1 | 8 +++++++-
doc/md/git-bug_ls.md | 8 +++++++-
4 files changed, 26 insertions(+), 3 deletions(-)

Detailed changes

README.md

@@ -161,6 +161,11 @@ Filter and sort bugs using a [query](doc/queries.md):
 git bug ls "status:open sort:edit"
 ```
 
+Search for bugs by text content:
+```
+git bug ls "foo bar" baz
+```
+
 You can now use commands like `show`, `comment`, `open` or `close` to display and modify bugs. For more details about each command, you can run `git bug <command> --help` or read the [command's documentation](doc/md/git-bug.md).
 
 ## Interactive terminal UI

commands/ls.go

@@ -38,12 +38,18 @@ func newLsCommand() *cobra.Command {
 		Short: "List bugs.",
 		Long: `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.`,
+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.`,
 		Example: `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
+
+Do a full text search of all bugs:
+git bug ls "foo bar" baz
+
+Use queries, flags, and full text search:
+git bug ls status:open --by creation "foo bar" baz
 `,
 		PreRunE:  loadBackend(env),
 		PostRunE: closeBackend(env),

doc/man/git-bug-ls.1

@@ -16,7 +16,7 @@ git\-bug\-ls \- List 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.
+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.
 
 
 .SH OPTIONS
@@ -76,6 +76,12 @@ git bug ls status:open sort:edit\-desc
 List closed bugs sorted by creation with flags:
 git bug ls \-\-status closed \-\-by creation
 
+Do a full text search of all bugs:
+git bug ls "foo bar" baz
+
+Use queries, flags, and full text search:
+git bug ls status:open \-\-by creation "foo bar" baz
+
 
 .fi
 .RE

doc/md/git-bug_ls.md

@@ -6,7 +6,7 @@ List 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.
+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]
@@ -21,6 +21,12 @@ git bug ls status:open sort:edit-desc
 List closed bugs sorted by creation with flags:
 git bug ls --status closed --by creation
 
+Do a full text search of all bugs:
+git bug ls "foo bar" baz
+
+Use queries, flags, and full text search:
+git bug ls status:open --by creation "foo bar" baz
+
 ```
 
 ### Options