aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2021-03-29 10:58:10 +0200
committerMichael Muré <batolettre@gmail.com>2021-03-29 11:02:08 +0200
commitaa0449a3eafa42c8c0d44bbdc2b79c5f47bd2d32 (patch)
treecd0c72a0229bb38cf8096ce198384cdd972f66e2 /doc
parent5215634d0dca37c545904fbc8a12ddd9b8eb72df (diff)
parente985653701e8438e27ee5f925fd0aa7c0eef09fe (diff)
downloadgit-bug-aa0449a3eafa42c8c0d44bbdc2b79c5f47bd2d32.tar.gz
Merge remote-tracking branch 'origin/master' into dag-entity
Diffstat (limited to 'doc')
-rw-r--r--doc/man/git-bug-ls.14
-rw-r--r--doc/man/git-bug-webui.110
-rw-r--r--doc/md/git-bug_ls.md1
-rw-r--r--doc/md/git-bug_webui.md12
-rw-r--r--doc/queries.md19
5 files changed, 30 insertions, 16 deletions
diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-ls.1
index a0e60db7..0ab51709 100644
--- a/doc/man/git-bug-ls.1
+++ b/doc/man/git-bug-ls.1
@@ -29,6 +29,10 @@ You can pass an additional query to filter and order the list. This query can be
Filter by author
.PP
+\fB\-m\fP, \fB\-\-metadata\fP=[]
+ Filter by metadata. Example: github\-url=URL
+
+.PP
\fB\-p\fP, \fB\-\-participant\fP=[]
Filter by participant
diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1
index 954250a2..782cba56 100644
--- a/doc/man/git-bug-webui.1
+++ b/doc/man/git-bug-webui.1
@@ -22,6 +22,10 @@ Available git config:
.SH OPTIONS
.PP
+\fB\-\-host\fP="127.0.0.1"
+ Network address or hostname to listen to (default to 127.0.0.1)
+
+.PP
\fB\-\-open\fP[=false]
Automatically open the web UI in the default browser
@@ -31,13 +35,17 @@ Available git config:
.PP
\fB\-p\fP, \fB\-\-port\fP=0
- Port to listen to (default is random)
+ Port to listen to (default to random available port)
.PP
\fB\-\-read\-only\fP[=false]
Whether to run the web UI in read\-only mode
.PP
+\fB\-q\fP, \fB\-\-query\fP=""
+ The query to open in the web UI bug list
+
+.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for webui
diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_ls.md
index df54224f..7d1e490d 100644
--- a/doc/md/git-bug_ls.md
+++ b/doc/md/git-bug_ls.md
@@ -34,6 +34,7 @@ git bug ls status:open --by creation "foo bar" baz
```
-s, --status strings Filter by status. Valid values are [open,closed]
-a, --author strings Filter by author
+ -m, --metadata strings Filter by metadata. Example: github-url=URL
-p, --participant strings Filter by participant
-A, --actor strings Filter by actor
-l, --label strings Filter by label
diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md
index 98a61eb2..2d6be920 100644
--- a/doc/md/git-bug_webui.md
+++ b/doc/md/git-bug_webui.md
@@ -17,11 +17,13 @@ git-bug webui [flags]
### Options
```
- --open Automatically open the web UI in the default browser
- --no-open Prevent the automatic opening of the web UI in the default browser
- -p, --port int Port to listen to (default is random)
- --read-only Whether to run the web UI in read-only mode
- -h, --help help for webui
+ --host string Network address or hostname to listen to (default to 127.0.0.1) (default "127.0.0.1")
+ --open Automatically open the web UI in the default browser
+ --no-open Prevent the automatic opening of the web UI in the default browser
+ -p, --port int Port to listen to (default to random available port)
+ --read-only Whether to run the web UI in read-only mode
+ -q, --query string The query to open in the web UI bug list
+ -h, --help help for webui
```
### SEE ALSO
diff --git a/doc/queries.md b/doc/queries.md
index 0c881f35..3a38519b 100644
--- a/doc/queries.md
+++ b/doc/queries.md
@@ -10,8 +10,8 @@ A few tips:
- queries are case insensitive.
- you can combine as many qualifiers as you want.
-- you can use double quotes for multi-word search terms. For example, `author:"René Descartes"` searches for bugs opened by René Descartes, whereas `author:René Descartes` will throw an error since full-text search is not yet supported.
-- instead of a complete ID, you can use any prefix length. For example `participant=9ed1a`.
+- you can use double quotes for multi-word search terms. For example, `author:"René Descartes"` searches for bugs opened by René Descartes, whereas `author:René Descartes` will search for bug with René as the author and containing Descartes in a text.
+- instead of a complete ID, you can use any prefix length, as long as there is no ambiguity. For example `participant=9ed1a`.
## Filtering
@@ -36,7 +36,7 @@ You can filter based on the person who opened the bug.
### Filtering by participant
-You can filter based on the person who participated in any activity related to the bug (Opened bug or added a comment).
+You can filter based on the person who participated in any activity related to the bug (opened bug or added a comment).
| Qualifier | Example |
| --- | --- |
@@ -51,7 +51,6 @@ You can filter based on the person who interacted with the bug.
| --- | --- |
| `actor:QUERY` | `actor:descartes` matches bugs edited by `René Descartes` or `Robert Descartes` |
| | `actor:"rené descartes"` matches bugs edited by `René Descartes` |
-| `
**NOTE**: interaction with bugs include: opening the bug, adding comments, adding/removing labels etc...
@@ -90,8 +89,8 @@ Note: to deal with differently-set clocks on distributed computers, `git-bug` us
### Sort by Id
-| Qualifier | Example |
-| --- | --- |
+| Qualifier | Example |
+| --- | --- |
| `sort:id-desc` | `sort:id-desc` will sort bugs by their descending Ids |
| `sort:id` or `sort:id-asc` | `sort:id` will sort bugs by their ascending Ids |
@@ -99,8 +98,8 @@ Note: to deal with differently-set clocks on distributed computers, `git-bug` us
You can sort bugs by their creation time.
-| Qualifier | Example |
-| --- | --- |
+| Qualifier | Example |
+| --- | --- |
| `sort:creation` or `sort:creation-desc` | `sort:creation` will sort bugs by their descending creation time |
| `sort:creation-asc` | `sort:creation-asc` will sort bugs by their ascending creation time |
@@ -108,7 +107,7 @@ You can sort bugs by their creation time.
You can sort bugs by their edit time.
-| Qualifier | Example |
-| --- | --- |
+| Qualifier | Example |
+| --- | --- |
| `sort:edit` or `sort:edit-desc` | `sort:edit` will sort bugs by their descending last edition time |
| `sort:edit-asc` | `sort:edit-asc` will sort bugs by their ascending last edition time |