utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 23:46:24 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update git-fork man page

Browse source
This commit is contained in:
Luke Childs 2016-08-03 18:30:50 +01:00
parent ca78ac71ba
commit 93ae8fd81e
3 changed files with 23 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
man/git-fork.1
View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-FORK" "1" "July 2016" "" "Git Extras"
.TH "GIT\-FORK" "1" "August 2016" "" "Git Extras"
.
.SH "NAME"
\fBgit\-fork\fR \- Fork a repo on github
@ -37,6 +37,9 @@ adds the forked repo as a remote called \fBorigin\fR
.
.IP "" 0
.
.P
Remotes will use ssh if you have it configured with GitHub, if not, https will be used\.
.
.SH "EXAMPLE"
Fork expect\.js:
.
@ -74,10 +77,10 @@ $ \.\.<forks into your github profile and clones repo locally to expect\.js dir>
$ cd expect\.js && git remote \-v
origin https://github\.com/<user>/expect\.js (fetch)
origin https://github\.com/<user>/expect\.js (push)
upstream https://github\.com/LearnBoost/expect\.js (fetch)
upstream https://github\.com/LearnBoost/expect\.js (push)
origin git@github\.com:<user>/expect\.js (fetch)
origin git@github\.com:<user>/expect\.js (push)
upstream git@github\.com:LearnBoost/expect\.js (fetch)
upstream git@github\.com:LearnBoost/expect\.js (push)
.
.fi
.

14
man/git-fork.html
View file

@ -97,6 +97,8 @@
</ol>
<p> Remotes will use ssh if you have it configured with GitHub, if not, https will be used.</p>
<h2 id="EXAMPLE">EXAMPLE</h2>
<p> Fork expect.js:</p>
@ -115,10 +117,10 @@
$ cd expect.js &amp;&amp; git remote -v
origin https://github.com/&lt;user>/expect.js (fetch)
origin https://github.com/&lt;user>/expect.js (push)
upstream https://github.com/LearnBoost/expect.js (fetch)
upstream https://github.com/LearnBoost/expect.js (push)
origin git@github.com:&lt;user>/expect.js (fetch)
origin git@github.com:&lt;user>/expect.js (push)
upstream git@github.com:LearnBoost/expect.js (fetch)
upstream git@github.com:LearnBoost/expect.js (push)
</code></pre>
<p> If the current dir is a clone of expect.js, this has the same effect:</p>
@ -128,7 +130,7 @@ $ cd expect.js &amp;&amp; git remote -v
<h2 id="AUTHOR">AUTHOR</h2>
<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>
<p>Written by Andrew Griffiths &lt;<a href="&#109;&#97;&#x69;&#x6c;&#116;&#x6f;&#58;&#109;&#97;&#x69;&#x6c;&#64;&#x61;&#x6e;&#x64;&#x72;&#101;&#x77;&#103;&#114;&#x69;&#x66;&#102;&#105;&#116;&#x68;&#115;&#111;&#110;&#108;&#105;&#110;&#101;&#46;&#x63;&#111;&#x6d;" data-bare-link="true">&#109;&#97;&#105;&#x6c;&#x40;&#97;&#110;&#x64;&#114;&#101;&#x77;&#x67;&#114;&#x69;&#102;&#102;&#x69;&#x74;&#104;&#115;&#x6f;&#110;&#x6c;&#x69;&#110;&#x65;&#46;&#99;&#x6f;&#109;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -141,7 +143,7 @@ $ cd expect.js &amp;&amp; git remote -v
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>July 2016</li>
<li class='tc'>August 2016</li>
<li class='tr'>git-fork(1)</li>
</ol>

12
man/git-fork.md
View file

@ -16,9 +16,11 @@ git-fork(1) -- Fork a repo on github
If a url is not given and the current dir is a github repo, fork the repo.
1. forks the current repo
3. rename the `origin` remote repo to `upstream`
2. rename the `origin` remote repo to `upstream`
3. adds the forked repo as a remote called `origin`
Remotes will use ssh if you have it configured with GitHub, if not, https will be used.
## EXAMPLE
Fork expect.js:
@ -35,10 +37,10 @@ git-fork(1) -- Fork a repo on github
$ cd expect.js && git remote -v
origin https://github.com/<user>/expect.js (fetch)
origin https://github.com/<user>/expect.js (push)
upstream https://github.com/LearnBoost/expect.js (fetch)
upstream https://github.com/LearnBoost/expect.js (push)
origin git@github.com:<user>/expect.js (fetch)
origin git@github.com:<user>/expect.js (push)
upstream git@github.com:LearnBoost/expect.js (fetch)
upstream git@github.com:LearnBoost/expect.js (push)
If the current dir is a clone of expect.js, this has the same effect: