git-pr: mention the limitation of -m option

This commit is contained in:
spacewander 2019-08-30 09:23:08 +08:00
parent a56e14488e
commit a921e88d76
3 changed files with 12 additions and 4 deletions

View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-PR" "1" "June 2019" "" "Git Extras"
.TH "GIT\-PR" "1" "August 2019" "" "Git Extras"
.
.SH "NAME"
\fBgit\-pr\fR \- Checks out a pull request locally
@ -31,7 +31,7 @@ GitHub pull request URL in the format \fBhttps://github\.com/tj/git\-extras/pull
\-m | \-\-merge
.
.P
Checkout a merge commit against the branch the pull request is targeting\.
Checkout a merge commit against the branch the pull request is targeting\. Because this feature uses a private API with which GitHub checks the pull request\'s mergeability, it only works with the opened pull request\. If the merge commit is not up\-to\-date, please visit the pull request web page to trigger the rebuild\.
.
.SH "EXAMPLES"
This checks out the pull request \fB226\fR from \fBorigin\fR:

View file

@ -98,7 +98,11 @@
<p> -m | --merge</p>
<p> Checkout a merge commit against the branch the pull request is targeting.</p>
<p> Checkout a merge commit against the branch the pull request is targeting.
Because this feature uses a private API with which GitHub checks the pull
request's mergeability, it only works with the opened pull request. If the merge
commit is not up-to-date, please visit the pull request web page to trigger the
rebuild.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
@ -190,7 +194,7 @@ Deleted branch pr/775 (was de6e51c).
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>June 2019</li>
<li class='tc'>August 2019</li>
<li class='tr'>git-pr(1)</li>
</ol>

View file

@ -26,6 +26,10 @@ git-pr(1) -- Checks out a pull request locally
-m | --merge
Checkout a merge commit against the branch the pull request is targeting.
Because this feature uses a private API with which GitHub checks the pull
request's mergeability, it only works with the opened pull request. If the merge
commit is not up-to-date, please visit the pull request web page to trigger the
rebuild.
## EXAMPLES