From: Frantisek Hrbata <frantisek@hrbata.com>
Date: Fri, 18 Dec 2020 10:00:16 +0000 (+0100)
Subject: doc: add git-mr-reply description
X-Git-Tag: v0.2~34
X-Git-Url: http://www.hrbata.com/gitweb/?a=commitdiff_plain;h=e3dca3212f5485c878db50802ed7456924c6299a;p=gimrr.git

doc: add git-mr-reply description

Signed-off-by: Frantisek Hrbata <frantisek@hrbata.com>
---

diff --git a/Documentation/git-mr-reply.txt b/Documentation/git-mr-reply.txt
new file mode 100644
index 0000000..fd02352
--- /dev/null
+++ b/Documentation/git-mr-reply.txt
@@ -0,0 +1,63 @@
+GIT-MR-REPLY(1)
+===============
+:doctype: manpage
+
+
+NAME
+----
+git-mr-reply - Reply to comment, patch(commit) or MR
+
+
+SYNOPSIS
+--------
+*git-mr-reply* ['OPTIONS'] ['REV']
+
+
+DESCRIPTION
+-----------
+Launch editor with quoted comment, patch(commit) or MR description as a reply.
+When 'REV' is specified, reply to specific comment or patch identified
+by it's revision(SHA-1). If 'REV' is not specified, reply to the currently
+checked out 'MR'(HEAD) or to 'MR' description identified with the *-m* option.
+Each comment or patch is related to a specific 'MR' and 'git-mr-reply' tries
+to figure out to which 'MR' it belongs to. Although comments should be unique,
+patches(commits) may be part of several 'MRs'. For example if you create a
+new 'MR' by adding new commits atop of other existing 'MR'. In such case you
+will need to specify the *-m* option along with 'REV' to avoid this ambiguity.
+'git-mr-reply' will notify you about such cases.
+
+After your reply is ready and editor exits with no error, 'git-mr-reply'
+calls link:git-mr-sendmail.html[git-mr-tag(1)] to create a new mbox entry.
+Note that the email headers, which are part of the quoted reply, are used
+by link:git-mr-sendmail.html[git-mr-sendmail(1)] and need to be preserved.
+
+'git-mr-reply' aborts if editor exits with non-zero exit status or if
+the reply is empty.
+
+
+OPTIONS
+-------
+*-m, --mr* 'MR'::
+    Reply to specific 'MR'. This option also may be required for
+    patches(comments) which are included in multiple 'MRs' to avoid
+    ambiguity.
+
+*-w, --write-revs* 'FILE'::
+    Default 'FILE' is '$HOME/.gimrr/comment.revs'. It contains list
+    of comment revisions which were read. Meaning they are not
+    reported as new with link:git-mr-comment-list.html[git-mr-comment-list(1)].
+
+EXAMPLES
+--------
+`$ git mr-reply`::
+  Reply to the currently checked out 'MR'.
+
+`$ git mr-reply REV`::
+  Reply to comment or commit identified by 'REV'.
+
+`$ git mr-reply -m MR REV`::
+  Reply to commit identified by 'REV' in specific 'MR'.
+
+SEE ALSO
+--------
+link:git-mr.html[git-mr(1)]