1
0
dox/docs/org/git.html

362 lines
10 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>git</title>
<!-- 2019-01-29 Tue 12:39 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<meta name="author" content="root" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center; }
.todo { font-family: monospace; color: red; }
.done { color: green; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.right { margin-left: auto; margin-right: 0px; text-align: right; }
.left { margin-left: 0px; margin-right: auto; text-align: left; }
.center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
pre.src-sh:before { content: 'sh'; }
pre.src-bash:before { content: 'sh'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-R:before { content: 'R'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-java:before { content: 'Java'; }
pre.src-sql:before { content: 'SQL'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.right { text-align: center; }
th.left { text-align: center; }
th.center { text-align: center; }
td.right { text-align: right; }
td.left { text-align: left; }
td.center { text-align: center; }
dt { font-weight: bold; }
.footpara:nth-child(2) { display: inline; }
.footpara { display: block; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2013 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">git</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1. Git</a>
<ul>
<li><a href="#sec-1-1">1.1. To create a repo</a></li>
<li><a href="#sec-1-2">1.2. To collaborate on an existing repo</a></li>
<li><a href="#sec-1-3">1.3. To push up your changes</a></li>
</ul>
</li>
<li><a href="#sec-2">2. Walkthrough</a>
<ul>
<li><a href="#sec-2-1">2.1. Cloning</a></li>
<li><a href="#sec-2-2">2.2. Forking</a></li>
<li><a href="#sec-2-3">2.3. Remotes</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Git</h2>
<div class="outline-text-2" id="text-1">
</div><div id="outline-container-sec-1-1" class="outline-3">
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> To create a repo</h3>
<div class="outline-text-3" id="text-1-1">
<p>
on gogs
</p>
<ol class="org-ol">
<li>git config &#x2013;global user.name "&lt;gogsusername&gt;@whatever"
</li>
<li>create repo in gogs
</li>
</ol>
<p>
on computer
</p>
<ol class="org-ol">
<li>apt install git
</li>
<li>git clone repo
</li>
<li>touch README.md
</li>
<li>git add -A
</li>
<li>git commit -m "first commit"
</li>
<li>git push origin master
</li>
</ol>
</div>
</div>
<div id="outline-container-sec-1-2" class="outline-3">
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> To collaborate on an existing repo</h3>
<div class="outline-text-3" id="text-1-2">
<ol class="org-ol">
<li>Be added as a collaborator
</li>
<li>git clone &lt;repo address (from gogs)&gt;
</li>
<li><code>git checkout -b &lt;branchname&gt;</code>
<ul class="org-ul">
<li><code>-b</code> creates a new branch if one doesn't exist
</li>
<li>you can name branch anything, start w/ your gogs name
</li>
</ul>
</li>
<li>make changes
</li>
</ol>
</div>
</div>
<div id="outline-container-sec-1-3" class="outline-3">
<h3 id="sec-1-3"><span class="section-number-3">1.3</span> To push up your changes</h3>
<div class="outline-text-3" id="text-1-3">
<ol class="org-ol">
<li><code>git checkout master</code>
</li>
<li><code>git pull origin master</code>
</li>
<li><code>git checkout &lt;branchname&gt;</code>
</li>
<li><code>git merge master</code>
</li>
<li><code>git add -A</code>
</li>
<li>~git commit -m "concise explanation of what I did"~
</li>
<li><code>git push origin &lt;yourname&gt;</code>
</li>
<li>submit a pull request
</li>
</ol>
<p>
Change last commit before pushing:
git add [more files]
git commit &#x2013;amend
</p>
</div>
</div>
</div>
<div id="outline-container-sec-2" class="outline-2">
<h2 id="sec-2"><span class="section-number-2">2</span> Walkthrough</h2>
<div class="outline-text-2" id="text-2">
<p>
This little walkthrough uses this repository as an example.
</p>
</div>
<div id="outline-container-sec-2-1" class="outline-3">
<h3 id="sec-2-1"><span class="section-number-3">2.1</span> Cloning</h3>
<div class="outline-text-3" id="text-2-1">
<p>
<code>git clone https://irc.anarchyplanet.org/git/AnarchyPlanet/dox</code>
</p>
<p>
If you added a ssh key already:
<code>git clone git@HOST:user/repo</code>
</p>
</div>
</div>
<div id="outline-container-sec-2-2" class="outline-3">
<h3 id="sec-2-2"><span class="section-number-3">2.2</span> Forking</h3>
<div class="outline-text-3" id="text-2-2">
<p>
To change a repository you'll need a local copy of it, this is called forking a git repository.
</p>
<p>
You can do so by clicking on 'Fork' at the top right of the web interface.
</p>
</div>
</div>
<div id="outline-container-sec-2-3" class="outline-3">
<h3 id="sec-2-3"><span class="section-number-3">2.3</span> Remotes</h3>
<div class="outline-text-3" id="text-2-3">
<p>
Git can manage multiple remote locations called <code>remotes</code>.
</p>
<p>
The default remote after cloning is <code>origin</code>.
This makes sense when cloning your own, if you started with someone else's repository it makes sense to rename it to <code>upstream</code>:
</p>
<p>
<code>git remote rename origin upstream</code>
</p>
<p>
Now add your fork URL:
</p>
<p>
<code>git remote add origin git@irc.anarchyplanet.org:2222:USER/dox</code>
</p>
<p>
For this to work you need to define the key file in <code>.ssh/config</code>:
</p>
<p>
```
Host AP
Hostname irc.anarchyplanet.org
User git
Port 2222
IdentityFile ~/.ssh/id<sub>rsa</sub>
```
</p>
<p>
After this your .git/config should have these sections:
```
[remote "upstream"]
url = <a href="https://irc.anarchyplanet.org/git/AnarchyPlanet/dox">https://irc.anarchyplanet.org/git/AnarchyPlanet/dox</a>
fetch = +refs/heads/*:refs/remotes/upstream/*
</p>
<p>
[remote "origin"]
url = AP:USER/dox
fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
remote = upstream
merge = refs/heads/master
```
</p>
<p>
Now you should be able to push:
<code>git push origin branchname --set-upstream origin branchname</code>
</p>
<p>
Edit this guide: <a href="https://irc.anarchyplanet.org/pad/p/dox-git">https://irc.anarchyplanet.org/pad/p/dox-git</a>
</p>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: root</p>
<p class="date">Created: 2019-01-29 Tue 12:39</p>
<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.5.1 (<a href="http://orgmode.org">Org</a> mode 8.2.10)</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>