diff options
author | Michael Muré <batolettre@gmail.com> | 2018-09-15 20:31:40 +0200 |
---|---|---|
committer | Michael Muré <batolettre@gmail.com> | 2018-09-15 20:31:40 +0200 |
commit | 6cdc6c087e858e18c5c54e92c60ceb78a37fc3f2 (patch) | |
tree | 13f378972d6dd152be5adfcf2df2c2b6aee95db8 /doc | |
parent | bfb5e96aab9e78f05942151060cc92fdaa32bedd (diff) | |
download | git-bug-6cdc6c087e858e18c5c54e92c60ceb78a37fc3f2.tar.gz |
commands: add `git bug comment add` to add a comment
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/git-bug-add.1 | 41 | ||||
-rw-r--r-- | doc/man/git-bug-comment-add.1 | 29 | ||||
-rw-r--r-- | doc/man/git-bug-comment.1 | 6 | ||||
-rw-r--r-- | doc/man/git-bug.1 | 2 | ||||
-rw-r--r-- | doc/md/git-bug.md | 4 | ||||
-rw-r--r-- | doc/md/git-bug_add.md | 25 | ||||
-rw-r--r-- | doc/md/git-bug_comment.md | 5 | ||||
-rw-r--r-- | doc/md/git-bug_comment_add.md | 22 |
8 files changed, 126 insertions, 8 deletions
diff --git a/doc/man/git-bug-add.1 b/doc/man/git-bug-add.1 new file mode 100644 index 00000000..cc486564 --- /dev/null +++ b/doc/man/git-bug-add.1 @@ -0,0 +1,41 @@ +.TH "GIT-BUG" "1" "Sep 2018" "Generated from git-bug's source code" "" +.nh +.ad l + + +.SH NAME +.PP +git\-bug\-add \- Create a new bug + + +.SH SYNOPSIS +.PP +\fBgit\-bug add [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 add + + +.SH SEE ALSO +.PP +\fBgit\-bug(1)\fP diff --git a/doc/man/git-bug-comment-add.1 b/doc/man/git-bug-comment-add.1 new file mode 100644 index 00000000..1a2fc2dc --- /dev/null +++ b/doc/man/git-bug-comment-add.1 @@ -0,0 +1,29 @@ +.TH "GIT-BUG" "1" "Sep 2018" "Generated from git-bug's source code" "" +.nh +.ad l + + +.SH NAME +.PP +git\-bug\-comment\-add \- Add a new comment to a bug + + +.SH SYNOPSIS +.PP +\fBgit\-bug comment add <id> [flags]\fP + + +.SH DESCRIPTION +.PP +Add a new comment to a bug + + +.SH OPTIONS +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for add + + +.SH SEE ALSO +.PP +\fBgit\-bug\-comment(1)\fP diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-comment.1 index 7e172d6b..8ad43e5c 100644 --- a/doc/man/git-bug-comment.1 +++ b/doc/man/git-bug-comment.1 @@ -5,7 +5,7 @@ .SH NAME .PP -git\-bug\-comment \- Add a new comment to a bug +git\-bug\-comment \- Show a bug's comments .SH SYNOPSIS @@ -15,7 +15,7 @@ git\-bug\-comment \- Add a new comment to a bug .SH DESCRIPTION .PP -Add a new comment to a bug +Show a bug's comments .SH OPTIONS @@ -34,4 +34,4 @@ Add a new comment to a bug .SH SEE ALSO .PP -\fBgit\-bug(1)\fP +\fBgit\-bug(1)\fP, \fBgit\-bug\-comment\-add(1)\fP diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1 index 21f012b2..9d370dc8 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\-close(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-new(1)\fP, \fBgit\-bug\-open(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-webui(1)\fP +\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-close(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-open(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-webui(1)\fP diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md index 6131ed2c..b3f66627 100644 --- a/doc/md/git-bug.md +++ b/doc/md/git-bug.md @@ -20,12 +20,12 @@ git-bug [flags] ### SEE ALSO +* [git-bug add](git-bug_add.md) - Create a new bug * [git-bug close](git-bug_close.md) - Mark the bug as closed * [git-bug commands](git-bug_commands.md) - Display available commands -* [git-bug comment](git-bug_comment.md) - Add a new comment to a bug +* [git-bug comment](git-bug_comment.md) - Show a bug's comments * [git-bug label](git-bug_label.md) - Manipulate bug's label * [git-bug ls](git-bug_ls.md) - List bugs -* [git-bug new](git-bug_new.md) - Create a new bug * [git-bug open](git-bug_open.md) - Mark the bug as open * [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 diff --git a/doc/md/git-bug_add.md b/doc/md/git-bug_add.md new file mode 100644 index 00000000..21060f61 --- /dev/null +++ b/doc/md/git-bug_add.md @@ -0,0 +1,25 @@ +## git-bug add + +Create a new bug + +### Synopsis + +Create a new bug + +``` +git-bug add [flags] +``` + +### Options + +``` + -t, --title string Provide a title to describe the issue + -m, --message string Provide a message to describe the issue + -F, --file string Take the message from the given file. Use - to read the message from the standard input + -h, --help help for add +``` + +### SEE ALSO + +* [git-bug](git-bug.md) - A bugtracker embedded in Git + diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md index 8616c511..9870e5fe 100644 --- a/doc/md/git-bug_comment.md +++ b/doc/md/git-bug_comment.md @@ -1,10 +1,10 @@ ## git-bug comment -Add a new comment to a bug +Show a bug's comments ### Synopsis -Add a new comment to a bug +Show a bug's comments ``` git-bug comment <id> [flags] @@ -21,4 +21,5 @@ git-bug comment <id> [flags] ### SEE ALSO * [git-bug](git-bug.md) - A bugtracker embedded in Git +* [git-bug comment add](git-bug_comment_add.md) - Add a new comment to a bug diff --git a/doc/md/git-bug_comment_add.md b/doc/md/git-bug_comment_add.md new file mode 100644 index 00000000..412e40d7 --- /dev/null +++ b/doc/md/git-bug_comment_add.md @@ -0,0 +1,22 @@ +## git-bug comment add + +Add a new comment to a bug + +### Synopsis + +Add a new comment to a bug + +``` +git-bug comment add <id> [flags] +``` + +### Options + +``` + -h, --help help for add +``` + +### SEE ALSO + +* [git-bug comment](git-bug_comment.md) - Show a bug's comments + |