diff options
author | Michael Muré <batolettre@gmail.com> | 2020-11-22 22:15:51 +0100 |
---|---|---|
committer | Matěj Cepl <mcepl@cepl.eu> | 2024-11-03 00:51:41 +0100 |
commit | dbb9526b247f1d197ec9a524e34f6ca4c25cdd4a (patch) | |
tree | e5e4d4bbddf2d76029e3f42567cc8b500a3af0ad /doc/man | |
parent | fb705bb8f4ab7e44900520e018518d12885e0eca (diff) | |
download | git-bug-dbb9526b247f1d197ec9a524e34f6ca4c25cdd4a.tar.gz |
commands: add a command to export bugs as raw operations (NDJSON)
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/git-bug-export.1 | 77 | ||||
-rw-r--r-- | doc/man/git-bug.1 | 2 |
2 files changed, 78 insertions, 1 deletions
diff --git a/doc/man/git-bug-export.1 b/doc/man/git-bug-export.1 new file mode 100644 index 00000000..a6c1b1c5 --- /dev/null +++ b/doc/man/git-bug-export.1 @@ -0,0 +1,77 @@ +.nh +.TH "GIT\-BUG" "1" "Apr 2019" "Generated from git\-bug's source code" "" + +.SH NAME +.PP +git\-bug\-export \- Export bugs as a series of operations. + + +.SH SYNOPSIS +.PP +\fBgit\-bug export [QUERY] [flags]\fP + + +.SH DESCRIPTION +.PP +Export bugs as a series of operations. + +.PP +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 +.PP +\fB\-s\fP, \fB\-\-status\fP=[] + Filter by status. Valid values are [open,closed] + +.PP +\fB\-a\fP, \fB\-\-author\fP=[] + Filter by author + +.PP +\fB\-p\fP, \fB\-\-participant\fP=[] + Filter by participant + +.PP +\fB\-A\fP, \fB\-\-actor\fP=[] + Filter by actor + +.PP +\fB\-l\fP, \fB\-\-label\fP=[] + Filter by label + +.PP +\fB\-t\fP, \fB\-\-title\fP=[] + Filter by title + +.PP +\fB\-n\fP, \fB\-\-no\fP=[] + Filter by absence of something. Valid values are [label] + +.PP +\fB\-b\fP, \fB\-\-by\fP="creation" + Sort the results by a characteristic. Valid values are [id,creation,edit] + +.PP +\fB\-d\fP, \fB\-\-direction\fP="asc" + Select the sorting direction. Valid values are [asc,desc] + +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for export + + +.SH EXAMPLE +.PP +.RS + +.nf +See ls + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBgit\-bug(1)\fP diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1 index 9bf59164..1599d8b4 100644 --- a/doc/man/git-bug.1 +++ b/doc/man/git-bug.1 @@ -29,4 +29,4 @@ the same git remote you are already using to collaborate with other people. .SH SEE ALSO .PP -\fBgit-bug-bridge(1)\fP, \fBgit-bug-bug(1)\fP, \fBgit-bug-commands(1)\fP, \fBgit-bug-label(1)\fP, \fBgit-bug-pull(1)\fP, \fBgit-bug-push(1)\fP, \fBgit-bug-termui(1)\fP, \fBgit-bug-user(1)\fP, \fBgit-bug-version(1)\fP, \fBgit-bug-webui(1)\fP, \fBgit-bug-wipe(1)\fP +\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-bridge(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-deselect(1)\fP, \fBgit\-bug\-export(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-ls\-id(1)\fP, \fBgit\-bug\-ls\-label(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-rm(1)\fP, \fBgit\-bug\-select(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-status(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-title(1)\fP, \fBgit\-bug\-user(1)\fP, \fBgit\-bug\-version(1)\fP, \fBgit\-bug\-webui(1)\fP, \fBgit-bug-wipe(1)\fP |