Skip to content

Commit

Permalink
Merge pull request #506 from rstacruz/git-pr-manual
Browse files Browse the repository at this point in the history 
Update git PR manual to mention URLs
  • Loading branch information
@hemanth
hemanth committed Jan 22, 2016
2 parents 98d0d8c + 0fde295 commit e6cdd2c
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 148 deletions.
30 changes: 28 additions & 2 deletions man/git-pr.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-PR" "1" "December 2015" "" ""
.TH "GIT\-PR" "1" "January 2016" "" "Git Extras"
.
.SH "NAME"
\fBgit\-pr\fR \- Checks out a pull request locally
Expand All @@ -10,17 +10,26 @@
\fBgit\-pr\fR <number> [<remote>]
.
.br
\fBgit\-pr\fR <url>
.
.br
\fBgit\-pr clean\fR
.
.SH "DESCRIPTION"
Creates a local branch based on a GitHub pull request number, and switch to that branch afterwards\.
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:
.
Expand Down Expand Up @@ -57,6 +66,23 @@ $ git pr 226 upstream
.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
Expand Down
143 changes: 0 additions & 143 deletions man/git-pr.html
View file
Original file line number Diff line number Diff line change
@@ -1,143 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>git-pr(1) - Checks out a pull request locally</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>

<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>

<ol class='man-decor man-head man head'>
<li class='tl'>git-pr(1)</li>
<li class='tc'></li>
<li class='tr'>git-pr(1)</li>
</ol>

<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-pr</code> - <span class="man-whatis">Checks out a pull request locally</span>
</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><code>git-pr</code> &lt;number&gt; [&lt;remote&gt;]<br />
<code>git-pr clean</code></p>

<h2 id="DESCRIPTION">DESCRIPTION</h2>

<p> Creates a local branch based on a GitHub pull request number, and switch to
that branch afterwards.</p>

<h2 id="OPTIONS">OPTIONS</h2>

<p> &lt;remote&gt;</p>

<p> The name of the remote to fetch from. Defaults to <code>origin</code>.</p>

<h2 id="EXAMPLES">EXAMPLES</h2>

<p>This checks out the pull request <code>226</code> from <code>origin</code>:</p>

<pre><code>$ 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 -&gt; pr/226

Switched to branch 'pr/226'
</code></pre>

<p>This pulls from a different remote:</p>

<pre><code>$ git pr 226 upstream
</code></pre>

<p>To clean up old branches:</p>

<pre><code>$ git pr clean

Deleted branch pr/226 (was b96a8c2).
Deleted branch pr/220 (was d34dc0f).
</code></pre>

<h2 id="AUTHOR">AUTHOR</h2>

<p>Originally from https://gist.github.com/gnarf/5406589</p>

<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

<p>&lt;<a href="https://github.com/tj/git-extras/issues" data-bare-link="true">https://github.com/tj/git-extras/issues</a>&gt;</p>

<h2 id="SEE-ALSO">SEE ALSO</h2>

<p>&lt;<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>&gt;</p>


<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>December 2015</li>
<li class='tr'>git-pr(1)</li>
</ol>

</div>
</body>
</html>
19 changes: 16 additions & 3 deletions man/git-pr.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@ git-pr(1) -- Checks out a pull request locally
## SYNOPSIS

`git-pr` &lt;number&gt; [&lt;remote&gt;]<br>
`git-pr` &lt;url&gt;<br>
`git-pr clean`

## DESCRIPTION

Creates a local branch based on a GitHub pull request number, and switch to
that branch afterwards.
Creates a local branch based on a GitHub pull request number or URL, and
switch to that branch afterwards.

## OPTIONS

&lt;remote&gt;

The name of the remote to fetch from. Defaults to `origin`.

&lt;url&gt;

GitHub pull request URL in the format `https://github.com/tj/git-extras/pull/453`.

## EXAMPLES

This checks out the pull request `226` from `origin`:
Expand All @@ -36,6 +41,14 @@ This pulls from a different remote:

$ git pr 226 upstream

You can also checkout a pull request based on a GitHub URL:

$ 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'

To clean up old branches:

$ git pr clean
Expand Down

0 comments on commit e6cdd2c

Please sign in to comment.