tj.git-extras/man/git-pr.1
2019-02-02 11:45:27 +08:00

125 lines
1.9 KiB
Groff

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-PR" "1" "February 2019" "" "Git Extras"
.
.SH "NAME"
\fBgit\-pr\fR \- Checks out a pull request locally
.
.SH "SYNOPSIS"
\fBgit\-pr\fR <number> [<remote>]
.
.br
\fBgit\-pr\fR <[remote]:number>
.
.br
\fBgit\-pr\fR <url>
.
.br
\fBgit\-pr clean\fR
.
.SH "DESCRIPTION"
Creates a local branch based on a GitHub pull request number or URL, and switch to that branch afterwards\.
.
.SH "OPTIONS"
<remote>
.
.P
The name of the remote to fetch from\. Defaults to \fBorigin\fR\.
.
.P
<url>
.
.P
GitHub pull request URL in the format \fBhttps://github\.com/tj/git\-extras/pull/453\fR\.
.
.SH "EXAMPLES"
This checks out the pull request \fB226\fR from \fBorigin\fR:
.
.IP "" 4
.
.nf
$ git pr 226
remote: Counting objects: 12, done\.
remote: Compressing objects: 100% (9/9), done\.
remote: Total 12 (delta 3), reused 9 (delta 3)
Unpacking objects: 100% (12/12), done\.
From https://github\.com/tj/git\-extras
* [new ref] refs/pull/226/head \-> pr/226
Switched to branch \'pr/226\'
.
.fi
.
.IP "" 0
.
.P
This pulls from a different remote:
.
.IP "" 4
.
.nf
$ git pr 226 upstream
.
.fi
.
.IP "" 0
.
.P
This does the same thing as the command above:
.
.IP "" 4
.
.nf
$ git pr upstream:226
.
.fi
.
.IP "" 0
.
.P
You can also checkout a pull request based on a GitHub URL:
.
.IP "" 4
.
.nf
$ git pr https://github\.com/tj/git\-extras/pull/453
From https://github\.com/tj/git\-extras
* [new ref] refs/pull/453/head \-> pr/453
Switched to branch \'pr/453\'
.
.fi
.
.IP "" 0
.
.P
To clean up old branches:
.
.IP "" 4
.
.nf
$ git pr clean
Deleted branch pr/226 (was b96a8c2)\.
Deleted branch pr/220 (was d34dc0f)\.
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Originally from https://gist\.github\.com/gnarf/5406589
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>