From f78e5ba78e1c7d3140ea851c06dc9dfbc35e6c55 Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Sun, 20 Dec 2020 12:57:50 +0100 Subject: [PATCH] doc: add git-mr-comment-show.txt Signed-off-by: Frantisek Hrbata --- Documentation/git-mr-comment-show.txt | 55 +++++++++++++++++++++++++++++++++ Documentation/git-mr.txt | 1 + 2 files changed, 56 insertions(+) create mode 100644 Documentation/git-mr-comment-show.txt diff --git a/Documentation/git-mr-comment-show.txt b/Documentation/git-mr-comment-show.txt new file mode 100644 index 0000000..7649335 --- /dev/null +++ b/Documentation/git-mr-comment-show.txt @@ -0,0 +1,55 @@ +GIT-MR-COMMENT-SHOW(1) +====================== +:doctype: manpage + + +NAME +---- +git-mr-comment-show - Show comments + + +SYNOPSIS +-------- +*git-mr-comment-show* ['OPTIONS'] ['COMMENT' ['COMMENT' ...]] + + +DESCRIPTION +----------- +This is one of three basic commands for 'MR' review, along with +link:git-mr-comment-list.html[git-mr-comment-list(1)] and +link:git-mr-reply.html[git-mr-reply(1)]. It shows comments specified by +'COMMENT' revs or all comments if the *-A* option is used. 'COMMENT' +revs can be also passed on stdin. + +The output is in mbox format, so it can be used by MUAs, but this command +is primary intended for 'MR' review from command line. The +link:git-mr-mbox.html[git-mr-mbox(1)] command is more suited for generating +full mboxes, which contain also merge request description and patches. + + +OPTIONS +------- +*-A, --all*:: + Show all comments. Comments entered as positional arguments or on stdin are + ignored. + +*-, --stdin*:: + Show comments for revisions read from stdin. Comments entered as positional + arguments are ignored. + +*-w, --write-revs* 'FILE':: + Append revs for read comments to FILE (default: $HOME/.gimrr/comment.revs). + + +EXAMPLES +-------- +`$ git mr-comment-show -A`:: + Show comments for all MRs. + +`$ git mr-comment-list -A -n --fmt "{c}" | git mr-comment-show -`:: + Show new comments for all MRs. + + +SEE ALSO +-------- +link:git-mr.html[git-mr(1)] diff --git a/Documentation/git-mr.txt b/Documentation/git-mr.txt index 47a14bd..4a0236d 100644 --- a/Documentation/git-mr.txt +++ b/Documentation/git-mr.txt @@ -83,3 +83,4 @@ link:git-mr-mbox.html[git-mr-mbox(1)] link:git-mr-reply.html[git-mr-reply(1)] link:git-mr-merge.html[git-mr-merge(1)] link:git-mr-comment-list.html[git-mr-comment-list(1)] +link:git-mr-comment-show.html[git-mr-comment-show(1)] -- 1.7.10.4