diff options
| author | Mike Goldin <mike.goldin@protonmail.ch> | 2020-11-17 08:09:35 -0500 |
|---|---|---|
| committer | Mike Goldin <mike.goldin@protonmail.ch> | 2020-11-17 08:32:19 -0500 |
| commit | ee3841155e5c58b85408f29a8d44630da5de63f7 (patch) | |
| tree | 1b477423060292af296b32971cda1ca0045e0c0d | |
| parent | b494e06804dca860138da843e0c44912f692a280 (diff) | |
| download | git-bug-ee3841155e5c58b85408f29a8d44630da5de63f7.tar.gz | |
Update docs for full text search
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | commands/ls.go | 8 | ||||
| -rw-r--r-- | doc/man/git-bug-ls.1 | 8 | ||||
| -rw-r--r-- | doc/md/git-bug_ls.md | 8 |
4 files changed, 26 insertions, 3 deletions
@@ -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 diff --git a/commands/ls.go b/commands/ls.go index 769d60ba..f6d654b1 100644 --- a/commands/ls.go +++ b/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), diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-ls.1 index b77bc969..a0e60db7 100644 --- a/doc/man/git-bug-ls.1 +++ b/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 diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_ls.md index e2721c72..df54224f 100644 --- a/doc/md/git-bug_ls.md +++ b/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 |