summaryrefslogtreecommitdiffstatshomepage
path: root/doc/md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/md')
-rw-r--r--doc/md/git-bug.md3
-rw-r--r--doc/md/git-bug_commands.md19
-rw-r--r--doc/md/git-bug_version.md38
3 files changed, 34 insertions, 26 deletions
diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md
index a71d6dfb9..2ef0b7725 100644
--- a/doc/md/git-bug.md
+++ b/doc/md/git-bug.md
@@ -26,13 +26,12 @@ git-bug [flags]
* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers
* [git-bug bug](git-bug_bug.md) - List bugs
-* [git-bug commands](git-bug_commands.md) - Display available commands.
* [git-bug label](git-bug_label.md) - List valid labels
* [git-bug pull](git-bug_pull.md) - Pull updates from a git remote
* [git-bug push](git-bug_push.md) - Push updates to a git remote
* [git-bug termui](git-bug_termui.md) - Launch the terminal UI
* [git-bug user](git-bug_user.md) - List identities
-* [git-bug version](git-bug_version.md) - Show git-bug version information
+* [git-bug version](git-bug_version.md) - Print version information
* [git-bug webui](git-bug_webui.md) - Launch the web UI
* [git-bug wipe](git-bug_wipe.md) - Wipe git-bug from the git repository
diff --git a/doc/md/git-bug_commands.md b/doc/md/git-bug_commands.md
deleted file mode 100644
index bce599dd9..000000000
--- a/doc/md/git-bug_commands.md
+++ /dev/null
@@ -1,19 +0,0 @@
-## git-bug commands
-
-Display available commands.
-
-```
-git-bug commands [flags]
-```
-
-### Options
-
-```
- -p, --pretty Output the command description as well as Markdown compatible comment
- -h, --help help for commands
-```
-
-### SEE ALSO
-
-* [git-bug](git-bug.md) - A bug tracker embedded in Git
-
diff --git a/doc/md/git-bug_version.md b/doc/md/git-bug_version.md
index ceba8790f..a2569aff1 100644
--- a/doc/md/git-bug_version.md
+++ b/doc/md/git-bug_version.md
@@ -1,18 +1,46 @@
## git-bug version
-Show git-bug version information
+Print version information
+
+### Synopsis
+
+
+Print version information.
+
+Format:
+ git-bug <version> [commit[/dirty]] <compiler version> <platform> <arch>
+
+Format Description:
+ <version> may be one of:
+ - A semantic version string, prefixed with a "v", e.g. v1.2.3
+ - "undefined" (if not provided, or built with an invalid version string)
+
+ [commit], if present, is the commit hash that was checked out during the
+ build. This may be suffixed with '/dirty' if there were local file
+ modifications. This is indicative of your build being patched, or modified in
+ some way from the commit.
+
+ <compiler version> is the version of the go compiler used for the build.
+
+ <platform> is the target platform (GOOS).
+
+ <arch> is the target architecture (GOARCH).
+
```
git-bug version [flags]
```
+### Examples
+
+```
+git bug version
+```
+
### Options
```
- -n, --number Only show the version number
- -c, --commit Only show the commit hash
- -a, --all Show all version information
- -h, --help help for version
+ -h, --help help for version
```
### SEE ALSO