From 10a259b6823e1234e5add1ee62935f259c39f803 Mon Sep 17 00:00:00 2001 From: Michael Muré Date: Sat, 20 Feb 2021 13:24:28 +0100 Subject: doc: cleanup query documentation --- doc/queries.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) (limited to 'doc') 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 | -- cgit From cb61245078a0e8f14e359ed20e0582a695645a08 Mon Sep 17 00:00:00 2001 From: Miklos Vajna Date: Sun, 14 Feb 2021 16:03:51 +0100 Subject: Add ability to search by arbitrary metadata Example: ~/git/git-bug/git-bug ls --metadata github-url=https://github.com/author/myproject/issues/42 or ~/git/git-bug/git-bug ls metadata:github-url:\"https://github.com/author/myproject/issues/42\" Fixes the cmdline part of . --- doc/man/git-bug-ls.1 | 4 ++++ doc/md/git-bug_ls.md | 1 + 2 files changed, 5 insertions(+) (limited to 'doc') 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 @@ -28,6 +28,10 @@ You can pass an additional query to filter and order the list. This query can be \fB\-a\fP, \fB\-\-author\fP=[] 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/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 -- cgit From ea329aed6909cac85680dbae37f6f4dcca134f8b Mon Sep 17 00:00:00 2001 From: Sascha Date: Sun, 28 Feb 2021 16:27:14 +0100 Subject: Add option to specify host address '--host'-cmdline-option is added to the webui command. Previously, the WebUI couldn't be hosted inside of a container. As the WebUI-server only listend per default to localhost and there was no option to change the address, the server should listend to. This means, that the WebUI was only reachable from localhost. So only from inside of the container but never from outside. The '--host'-option allows to set the IP address or a hostname which the WebUI-server should listen to. E.g. by setting 0.0.0.0 or :: as address. Update documentation for new option. Update shell completion for new option. Compilation seems to add another go-gitlab version. --- doc/man/git-bug-webui.1 | 6 +++++- doc/md/git-bug_webui.md | 11 ++++++----- 2 files changed, 11 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 954250a2..6e4622be 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -21,6 +21,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,7 +35,7 @@ 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] diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md index 98a61eb2..ccfaff9a 100644 --- a/doc/md/git-bug_webui.md +++ b/doc/md/git-bug_webui.md @@ -17,11 +17,12 @@ 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 + -h, --help help for webui ``` ### SEE ALSO -- cgit From 626ec9835b4450fb2994ec931357279700437b6b Mon Sep 17 00:00:00 2001 From: Miklos Vajna Date: Sun, 7 Mar 2021 14:09:15 +0100 Subject: webui: allow specifying the initial query Example use-case: given a github URL in a source code comment or commit message, one can now run: git bug webui --query 'metadata:github-url:"https://github.com/author/myproject/issues/42"' on the commandline to look up the details of that issue on the web ui quickly, offline. Fixes . --- doc/man/git-bug-webui.1 | 4 ++++ doc/md/git-bug_webui.md | 13 +++++++------ 2 files changed, 11 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 6e4622be..6bed9143 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -41,6 +41,10 @@ Available git config: \fB\-\-read\-only\fP[=false] Whether to run the web UI in read\-only mode +.PP +\fB\-\-query\fP="" + Set a custom query + .PP \fB\-h\fP, \fB\-\-help\fP[=false] help for webui diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md index ccfaff9a..0cdfd517 100644 --- a/doc/md/git-bug_webui.md +++ b/doc/md/git-bug_webui.md @@ -17,12 +17,13 @@ git-bug webui [flags] ### Options ``` - --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 - -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 + --query string Set a custom query + -h, --help help for webui ``` ### SEE ALSO -- cgit From 3a819525d7811dcfb01d928af0e243de4388c456 Mon Sep 17 00:00:00 2001 From: Michael Muré Date: Sun, 7 Mar 2021 21:44:48 +0100 Subject: commands: minor fixes for the webui open with query - go fmt - add a shorthand - fix displayed webUI URL in the terminal --- doc/man/git-bug-webui.1 | 4 ++-- doc/md/git-bug_webui.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 6bed9143..782cba56 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -42,8 +42,8 @@ Available git config: Whether to run the web UI in read\-only mode .PP -\fB\-\-query\fP="" - Set a custom query +\fB\-q\fP, \fB\-\-query\fP="" + The query to open in the web UI bug list .PP \fB\-h\fP, \fB\-\-help\fP[=false] diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md index 0cdfd517..2d6be920 100644 --- a/doc/md/git-bug_webui.md +++ b/doc/md/git-bug_webui.md @@ -22,7 +22,7 @@ git-bug webui [flags] --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 - --query string Set a custom query + -q, --query string The query to open in the web UI bug list -h, --help help for webui ``` -- cgit