aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Muré <michael.mure@consensys.net>2019-02-20 21:56:33 +0100
committerMichael Muré <michael.mure@consensys.net>2019-02-20 21:56:33 +0100
commit59ea2e018e05e7a4033d572f819f4a696ab74397 (patch)
tree01a427bfc2f67208e1801e8e06a934d91eb9a777 /doc
parent09692456c7a5491b37a22d72e652de66ecc8d4e7 (diff)
downloadgit-bug-59ea2e018e05e7a4033d572f819f4a696ab74397.tar.gz
add a "version" command with various outputs, including the git hash and tag
Diffstat (limited to 'doc')
-rw-r--r--doc/man/git-bug-version.141
-rw-r--r--doc/man/git-bug.12
-rw-r--r--doc/md/git-bug.md1
-rw-r--r--doc/md/git-bug_version.md25
4 files changed, 68 insertions, 1 deletions
diff --git a/doc/man/git-bug-version.1 b/doc/man/git-bug-version.1
new file mode 100644
index 00000000..09bf6cf4
--- /dev/null
+++ b/doc/man/git-bug-version.1
@@ -0,0 +1,41 @@
+.TH "GIT-BUG" "1" "Feb 2019" "Generated from git-bug's source code" ""
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-version \- Show git\-bug version information
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug version [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Show git\-bug version information
+
+
+.SH OPTIONS
+.PP
+\fB\-n\fP, \fB\-\-number\fP[=false]
+ Only show the version number
+
+.PP
+\fB\-c\fP, \fB\-\-commit\fP[=false]
+ Only show the commit hash
+
+.PP
+\fB\-a\fP, \fB\-\-all\fP[=false]
+ Show all version informations
+
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+ help for version
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(1)\fP
diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1
index 82e9087a..123f9a33 100644
--- a/doc/man/git-bug.1
+++ b/doc/man/git-bug.1
@@ -31,4 +31,4 @@ the same git remote your are already using to collaborate with other peoples.
.SH SEE ALSO
.PP
-\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\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-ls\-label(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
+\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\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-ls\-label(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\-version(1)\fP, \fBgit\-bug\-webui(1)\fP
diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md
index 2cc44eff..e88cfd0c 100644
--- a/doc/md/git-bug.md
+++ b/doc/md/git-bug.md
@@ -39,5 +39,6 @@ git-bug [flags]
* [git-bug status](git-bug_status.md) - Display or change a bug status
* [git-bug termui](git-bug_termui.md) - Launch the terminal UI
* [git-bug title](git-bug_title.md) - Display or change a title
+* [git-bug version](git-bug_version.md) - Show git-bug version information
* [git-bug webui](git-bug_webui.md) - Launch the web UI
diff --git a/doc/md/git-bug_version.md b/doc/md/git-bug_version.md
new file mode 100644
index 00000000..6b6d4288
--- /dev/null
+++ b/doc/md/git-bug_version.md
@@ -0,0 +1,25 @@
+## git-bug version
+
+Show git-bug version information
+
+### Synopsis
+
+Show git-bug version information
+
+```
+git-bug version [flags]
+```
+
+### Options
+
+```
+ -n, --number Only show the version number
+ -c, --commit Only show the commit hash
+ -a, --all Show all version informations
+ -h, --help help for version
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md) - A bug tracker embedded in Git
+