mirror of https://github.com/MichaelMure/git-bug.git synced 2024-12-14 08:45:30 +03:00

Jed Fox fd21de5632 Cleanup queries.md (#41 )

* Improve grammar
* Improve clock-vs-timestamp message
* Fix whitespace
* Add some explanations
* Move the clock-vs-timestamp message to the top of the sorting section
* Clarify wording more
* Fix my misconception

2018-09-10 12:49:31 +02:00

3.9 KiB

Raw Blame History

Searching bugs

You can search bugs using a micro query language for both filtering and sorting. A query could look like this:

status:open sort:edit

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.

Filtering

Filtering by status

You can filter bugs based on their status.

Qualifier	Example
`status:open`	`status:open` matches open bugs
`status:closed`	`status:closed` matches closed bugs

Filtering by author

You can filter based on the person who opened the bug.

Qualifier	Example
`author:QUERY`	`author:descartes` matches bugs opened by `René Descartes` or `Robert Descartes`
	`author:"rené descartes"` matches bugs opened by `René Descartes`

Filtering by label

You can filter based on the bug's label.

Qualifier	Example
`label:LABEL`	`label:prod` matches bugs with the label `prod`
	`label:"Good first issue"` matches bugs with the label `Good first issue`

Filtering by missing feature

You can filter bugs based on the absence of something.

Qualifier	Example
`no:label`	`no:label` matches bugs with no labels

Sorting

You can sort results by adding a sort: qualifier to your query. “Descending” means most recent time or largest ID first, whereas “Ascending” means oldest time or smallest ID first.

Note: to deal with differently-set clocks on distributed computers, git-bug uses a logical clock internally rather than timestamps to order bug changes over time. That means that the timestamps recorded might not match the returned ordering. More on that in the documentation

Sort by Id

Qualifier	Example
`sort:id-desc`	`sor:id-desc` will sort bugs by their descending Ids
`sort:id` or `sort:id-asc`	`sor:id` will sort bugs by their ascending Ids

Sort by Creation time

You can sort bugs by their creation time.

Qualifier	Example
`sort:creation` or `sort:creation-desc`	`sor:creation` will sort bugs by their descending creation time
`sort:creation-asc`	`sor:creation-asc` will sort bugs by their ascending creation time

Sort by Edit time

You can sort bugs by their edit time.

Qualifier	Example
`sort:edit` or `sort:edit-desc`	`sor:edit` will sort bugs by their descending last edition time
`sort:edit-asc`	`sor:edit-asc` will sort bugs by their ascending last edition time

3.9 KiB Raw Blame History