aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-09-18 13:17:39 +0200
committerMichael Muré <batolettre@gmail.com>2018-09-18 13:17:39 +0200
commit5f9fd2a2d95bd23e5d6972ec822bf1fea3077804 (patch)
tree9c6b0a9ff684179916207689c6b5c808efb67eb7 /doc
parent0d5998eb67f9bbf146e15a127a2d6a89aa14eab9 (diff)
downloadgit-bug-5f9fd2a2d95bd23e5d6972ec822bf1fea3077804.tar.gz
commands: add a "select" command to select a bug for future implicit use
Diffstat (limited to 'doc')
-rw-r--r--doc/man/git-bug-close.129
-rw-r--r--doc/man/git-bug-new.141
-rw-r--r--doc/man/git-bug-open.129
-rw-r--r--doc/man/git-bug-select.143
-rw-r--r--doc/man/git-bug.12
-rw-r--r--doc/md/git-bug.md1
-rw-r--r--doc/md/git-bug_select.md31
7 files changed, 76 insertions, 100 deletions
diff --git a/doc/man/git-bug-close.1 b/doc/man/git-bug-close.1
deleted file mode 100644
index 4b7157f8..00000000
--- a/doc/man/git-bug-close.1
+++ /dev/null
@@ -1,29 +0,0 @@
-.TH "GIT-BUG" "1" "Sep 2018" "Generated from git-bug's source code" ""
-.nh
-.ad l
-
-
-.SH NAME
-.PP
-git\-bug\-close \- Mark the bug as closed
-
-
-.SH SYNOPSIS
-.PP
-\fBgit\-bug close <id> [flags]\fP
-
-
-.SH DESCRIPTION
-.PP
-Mark the bug as closed
-
-
-.SH OPTIONS
-.PP
-\fB\-h\fP, \fB\-\-help\fP[=false]
- help for close
-
-
-.SH SEE ALSO
-.PP
-\fBgit\-bug(1)\fP
diff --git a/doc/man/git-bug-new.1 b/doc/man/git-bug-new.1
deleted file mode 100644
index f963ea57..00000000
--- a/doc/man/git-bug-new.1
+++ /dev/null
@@ -1,41 +0,0 @@
-.TH "GIT-BUG" "1" "Sep 2018" "Generated from git-bug's source code" ""
-.nh
-.ad l
-
-
-.SH NAME
-.PP
-git\-bug\-new \- Create a new bug
-
-
-.SH SYNOPSIS
-.PP
-\fBgit\-bug new [flags]\fP
-
-
-.SH DESCRIPTION
-.PP
-Create a new bug
-
-
-.SH OPTIONS
-.PP
-\fB\-t\fP, \fB\-\-title\fP=""
- Provide a title to describe the issue
-
-.PP
-\fB\-m\fP, \fB\-\-message\fP=""
- Provide a message to describe the issue
-
-.PP
-\fB\-F\fP, \fB\-\-file\fP=""
- Take the message from the given file. Use \- to read the message from the standard input
-
-.PP
-\fB\-h\fP, \fB\-\-help\fP[=false]
- help for new
-
-
-.SH SEE ALSO
-.PP
-\fBgit\-bug(1)\fP
diff --git a/doc/man/git-bug-open.1 b/doc/man/git-bug-open.1
deleted file mode 100644
index 8cd433b6..00000000
--- a/doc/man/git-bug-open.1
+++ /dev/null
@@ -1,29 +0,0 @@
-.TH "GIT-BUG" "1" "Sep 2018" "Generated from git-bug's source code" ""
-.nh
-.ad l
-
-
-.SH NAME
-.PP
-git\-bug\-open \- Mark the bug as open
-
-
-.SH SYNOPSIS
-.PP
-\fBgit\-bug open <id> [flags]\fP
-
-
-.SH DESCRIPTION
-.PP
-Mark the bug as open
-
-
-.SH OPTIONS
-.PP
-\fB\-h\fP, \fB\-\-help\fP[=false]
- help for open
-
-
-.SH SEE ALSO
-.PP
-\fBgit\-bug(1)\fP
diff --git a/doc/man/git-bug-select.1 b/doc/man/git-bug-select.1
new file mode 100644
index 00000000..f73582fa
--- /dev/null
+++ b/doc/man/git-bug-select.1
@@ -0,0 +1,43 @@
+.TH "GIT-BUG" "1" "Sep 2018" "Generated from git-bug's source code" ""
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-select \- Select a bug for implicit use in future commands
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug select [<id>] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Select a bug for implicit use in future commands
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+ help for select
+
+
+.SH EXAMPLE
+.PP
+.RS
+
+.nf
+git bug select 2f15
+git bug comment
+git bug status
+
+
+.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 adcdd999..ae56f4a2 100644
--- a/doc/man/git-bug.1
+++ b/doc/man/git-bug.1
@@ -29,4 +29,4 @@ It use the same internal storage so it doesn't pollute your project. As you woul
.SH SEE ALSO
.PP
-\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-status(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-title(1)\fP, \fBgit\-bug\-webui(1)\fP
+\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(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\-webui(1)\fP
diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md
index 6825f481..f38c3c36 100644
--- a/doc/md/git-bug.md
+++ b/doc/md/git-bug.md
@@ -27,6 +27,7 @@ git-bug [flags]
* [git-bug ls](git-bug_ls.md) - List bugs
* [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote
* [git-bug push](git-bug_push.md) - Push bugs update to a git remote
+* [git-bug select](git-bug_select.md) - Select a bug for implicit use in future commands
* [git-bug show](git-bug_show.md) - Display the details of a bug
* [git-bug status](git-bug_status.md) - Show the bug status
* [git-bug termui](git-bug_termui.md) - Launch the terminal UI
diff --git a/doc/md/git-bug_select.md b/doc/md/git-bug_select.md
new file mode 100644
index 00000000..014ba512
--- /dev/null
+++ b/doc/md/git-bug_select.md
@@ -0,0 +1,31 @@
+## git-bug select
+
+Select a bug for implicit use in future commands
+
+### Synopsis
+
+Select a bug for implicit use in future commands
+
+```
+git-bug select [<id>] [flags]
+```
+
+### Examples
+
+```
+git bug select 2f15
+git bug comment
+git bug status
+
+```
+
+### Options
+
+```
+ -h, --help help for select
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md) - A bugtracker embedded in Git
+