Skip to content

Commit f22d7bc

Browse files
lukechildslukechilds
committed
Update git-fork man page
1 parent ca78ac7 commit f22d7bc

File tree

3 files changed

+15
-160
lines changed

3 files changed

+15
-160
lines changed

‎man/git-fork.1‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "GIT\-FORK" "1" "July 2016" "" "Git Extras"
4+
.TH "GIT\-FORK" "1" "August 2016" "" "Git Extras"
55
.
66
.SH "NAME"
77
\fBgit\-fork\fR \- Fork a repo on github
@@ -37,6 +37,9 @@ adds the forked repo as a remote called \fBorigin\fR
3737
.
3838
.IP "" 0
3939
.
40+
.P
41+
Remotes will use ssh if you have it configured with GitHub, if not, https will be used\.
42+
.
4043
.SH "EXAMPLE"
4144
Fork expect\.js:
4245
.
@@ -74,10 +77,10 @@ $ \.\.<forks into your github profile and clones repo locally to expect\.js dir>
7477

7578
$ cd expect\.js && git remote \-v
7679

77-
origin https://github\.com/<user>/expect\.js (fetch)
78-
origin https://github\.com/<user>/expect\.js (push)
79-
upstream https://github\.com/LearnBoost/expect\.js (fetch)
80-
upstream https://github\.com/LearnBoost/expect\.js (push)
80+
origin git@github\.com:<user>/expect\.js (fetch)
81+
origin git@github\.com:<user>/expect\.js (push)
82+
upstream git@github\.com:LearnBoost/expect\.js (fetch)
83+
upstream git@github\.com:LearnBoost/expect\.js (push)
8184
.
8285
.fi
8386
.

‎man/git-fork.html‎

Lines changed: 0 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -1,150 +0,0 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta http-equiv='content-type' value='text/html;charset=utf8'>
5-
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6-
<title>git-fork(1) - Fork a repo on github</title>
7-
<style type='text/css' media='all'>
8-
/* style: man */
9-
body#manpage {margin:0}
10-
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11-
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12-
.mp h2 {margin:10px 0 0 0}
13-
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14-
.mp h3 {margin:0 0 0 4ex}
15-
.mp dt {margin:0;clear:left}
16-
.mp dt.flush {float:left;width:8ex}
17-
.mp dd {margin:0 0 0 9ex}
18-
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19-
.mp pre {margin-bottom:20px}
20-
.mp pre+h2,.mp pre+h3 {margin-top:22px}
21-
.mp h2+pre,.mp h3+pre {margin-top:5px}
22-
.mp img {display:block;margin:auto}
23-
.mp h1.man-title {display:none}
24-
.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}
25-
.mp h2 {font-size:16px;line-height:1.25}
26-
.mp h1 {font-size:20px;line-height:2}
27-
.mp {text-align:justify;background:#fff}
28-
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29-
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30-
.mp u {text-decoration:underline}
31-
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32-
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33-
.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}
34-
.mp b.man-ref {font-weight:normal;color:#434241}
35-
.mp pre {padding:0 4ex}
36-
.mp pre code {font-weight:normal;color:#434241}
37-
.mp h2+pre,h3+pre {padding-left:0}
38-
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}
39-
ol.man-decor {width:100%}
40-
ol.man-decor li.tl {text-align:left}
41-
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42-
ol.man-decor li.tr {text-align:right;float:right}
43-
</style>
44-
</head>
45-
<!--
46-
The following styles are deprecated and will be removed at some point:
47-
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
48-
49-
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
50-
.man-navigation should be used instead.
51-
-->
52-
<body id='manpage'>
53-
<div class='mp' id='man'>
54-
55-
<div class='man-navigation' style='display:none'>
56-
<a href="#NAME">NAME</a>
57-
<a href="#SYNOPSIS">SYNOPSIS</a>
58-
<a href="#DESCRIPTION">DESCRIPTION</a>
59-
<a href="#EXAMPLE">EXAMPLE</a>
60-
<a href="#AUTHOR">AUTHOR</a>
61-
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
62-
<a href="#SEE-ALSO">SEE ALSO</a>
63-
</div>
64-
65-
<ol class='man-decor man-head man head'>
66-
<li class='tl'>git-fork(1)</li>
67-
<li class='tc'>Git Extras</li>
68-
<li class='tr'>git-fork(1)</li>
69-
</ol>
70-
71-
<h2 id="NAME">NAME</h2>
72-
<p class="man-name">
73-
<code>git-fork</code> - <span class="man-whatis">Fork a repo on github</span>
74-
</p>
75-
76-
<h2 id="SYNOPSIS">SYNOPSIS</h2>
77-
78-
<p><code>git-fork</code> [&lt;github-repo-url&gt;]</p>
79-
80-
<h2 id="DESCRIPTION">DESCRIPTION</h2>
81-
82-
<p> If a github repo url is given, fork the repo. Like clone but forks first.</p>
83-
84-
<ol>
85-
<li>forks the repo on github</li>
86-
<li>clones the repo into the current dir</li>
87-
<li>adds the original repo as a remote called <code>upstream</code></li>
88-
</ol>
89-
90-
91-
<p> If a url is not given and the current dir is a github repo, fork the repo.</p>
92-
93-
<ol>
94-
<li>forks the current repo</li>
95-
<li>rename the <code>origin</code> remote repo to <code>upstream</code></li>
96-
<li>adds the forked repo as a remote called <code>origin</code></li>
97-
</ol>
98-
99-
100-
<h2 id="EXAMPLE">EXAMPLE</h2>
101-
102-
<p> Fork expect.js:</p>
103-
104-
<pre><code>$ git fork https://github.com/LearnBoost/expect.js
105-
</code></pre>
106-
107-
<p> or just:</p>
108-
109-
<pre><code>$ git fork LearnBoost/expect.js
110-
</code></pre>
111-
112-
<p> Then:</p>
113-
114-
<pre><code>$ ..&lt;forks into your github profile and clones repo locally to expect.js dir&gt;...
115-
116-
$ cd expect.js &amp;&amp; git remote -v
117-
118-
origin https://github.com/&lt;user>/expect.js (fetch)
119-
origin https://github.com/&lt;user>/expect.js (push)
120-
upstream https://github.com/LearnBoost/expect.js (fetch)
121-
upstream https://github.com/LearnBoost/expect.js (push)
122-
</code></pre>
123-
124-
<p> If the current dir is a clone of expect.js, this has the same effect:</p>
125-
126-
<pre><code>$ git fork
127-
</code></pre>
128-
129-
<h2 id="AUTHOR">AUTHOR</h2>
130-
131-
<p>Written by Andrew Griffiths &lt;<a href="&#x6d;&#97;&#x69;&#108;&#x74;&#111;&#x3a;&#x6d;&#x61;&#x69;&#x6c;&#64;&#97;&#x6e;&#100;&#x72;&#101;&#x77;&#x67;&#x72;&#105;&#x66;&#x66;&#x69;&#x74;&#x68;&#x73;&#x6f;&#110;&#108;&#105;&#x6e;&#101;&#46;&#x63;&#111;&#109;" data-bare-link="true">&#x6d;&#x61;&#105;&#108;&#64;&#97;&#110;&#100;&#114;&#x65;&#119;&#x67;&#x72;&#x69;&#x66;&#102;&#105;&#116;&#x68;&#115;&#111;&#x6e;&#108;&#105;&#x6e;&#x65;&#x2e;&#x63;&#111;&#x6d;</a>&gt;</p>
132-
133-
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
134-
135-
<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>
136-
137-
<h2 id="SEE-ALSO">SEE ALSO</h2>
138-
139-
<p>&lt;<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>&gt;</p>
140-
141-
142-
<ol class='man-decor man-foot man foot'>
143-
<li class='tl'></li>
144-
<li class='tc'>July 2016</li>
145-
<li class='tr'>git-fork(1)</li>
146-
</ol>
147-
148-
</div>
149-
</body>
150-
</html>

‎man/git-fork.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ git-fork(1) -- Fork a repo on github
1616
If a url is not given and the current dir is a github repo, fork the repo.
1717

1818
1. forks the current repo
19-
3. rename the `origin` remote repo to `upstream`
19+
2. rename the `origin` remote repo to `upstream`
2020
3. adds the forked repo as a remote called `origin`
2121

22+
Remotes will use ssh if you have it configured with GitHub, if not, https will be used.
23+
2224
## EXAMPLE
2325

2426
Fork expect.js:
@@ -35,10 +37,10 @@ git-fork(1) -- Fork a repo on github
3537

3638
$ cd expect.js && git remote -v
3739

38-
origin https://github.com/<user>/expect.js (fetch)
39-
origin https://github.com/<user>/expect.js (push)
40-
upstream https://github.com/LearnBoost/expect.js (fetch)
41-
upstream https://github.com/LearnBoost/expect.js (push)
40+
origin git@github.com:<user>/expect.js (fetch)
41+
origin git@github.com:<user>/expect.js (push)
42+
upstream git@github.com:LearnBoost/expect.js (fetch)
43+
upstream git@github.com:LearnBoost/expect.js (push)
4244

4345
If the current dir is a clone of expect.js, this has the same effect:
4446

0 commit comments

Comments
 (0)