add docs for git-merge-into

This commit is contained in:
spacewander 2015-03-10 23:50:09 +08:00
parent d94663312f
commit 46525fbfe8
3 changed files with 276 additions and 0 deletions

76
man/git-merge-into.1 Normal file
View file

@ -0,0 +1,76 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-MERGE\-INTO" "1" "March 2015" "" "Git Extras"
.
.SH "NAME"
\fBgit\-merge\-into\fR \- Merge one branch into another
.
.SH "SYNOPSIS"
\fBgit merge\-into\fR [src] <dest> [\-\-ff]
.
.SH "DESCRIPTION"
Merge one branch into another, and keep yourself on current branch\. If src branch not given, it will merge current one to dest\.
.
.SH "OPTIONS"
<src>
.
.P
The name of the branch will be merged into\. If this not given, use current branch as default\.
.
.P
<dest>
.
.P
The name of the branch to merge into\.
.
.P
\-\-ff
.
.P
Try to use \fBgit push\fR instead of \fBgit merge\fR\. Only work on fast\-forward mode\.
.
.SH "EXAMPLES"
Assume the following history exists and the current branch is src:
.
.IP "" 4
.
.nf
A\-\-\-B\-\-\-C src(current)
/
D\-\-\-E\-\-\-F\-\-\-G dest
.
.fi
.
.IP "" 0
.
.P
After running \fBgit merge\-into dest\fR, it will look like this:
.
.IP "" 4
.
.nf
A\-\-\-B\-\-\-C src(current)
/ \e
D\-\-\-E\-\-\-F\-\-\-G\-\-\-H dest
.
.fi
.
.IP "" 0
.
.P
The \fBH\fR commit will record the merge result, just like what \fBgit merge\fR does\. And \fBsrc\fR is still the current branch\.
.
.P
The default implementation of \fBmerge\-into\fR use \fBgit checkout\fR and \fBgit merge\fR, which may cause temporary change in the working tree\. If you make sure your branch can be merged fast\-forward, add \fB\-\-ff\fR to avoid files change\.
.
.SH "AUTHOR"
Written by spacewander <\fIspacewanderlzx@gmail\.com\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>

143
man/git-merge-into.html Normal file
View file

@ -0,0 +1,143 @@
<!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-merge-into(1) - Merge one branch into another</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-merge-into(1)</li>
<li class='tc'>Git Extras</li>
<li class='tr'>git-merge-into(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-merge-into</code> - <span class="man-whatis">Merge one branch into another</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git merge-into</code> [src] &lt;dest&gt; [--ff]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Merge one branch into another, and keep yourself on current branch. If src branch not given, it will merge current one to dest.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p> &lt;src&gt;</p>
<p> The name of the branch will be merged into. If this not given, use current branch as default.</p>
<p> &lt;dest&gt;</p>
<p> The name of the branch to merge into.</p>
<p> --ff</p>
<p> Try to use <code>git push</code> instead of <code>git merge</code>. Only work on fast-forward mode.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<p>Assume the following history exists and the current branch is src:</p>
<pre><code> A---B---C src(current)
/
D---E---F---G dest
</code></pre>
<p>After running <code>git merge-into dest</code>, it will look like this:</p>
<pre><code> A---B---C src(current)
/ \
D---E---F---G---H dest
</code></pre>
<p>The <code>H</code> commit will record the merge result, just like what <code>git merge</code> does.
And <code>src</code> is still the current branch.</p>
<p>The default implementation of <code>merge-into</code> use <code>git checkout</code> and <code>git merge</code>,
which may cause temporary change in the working tree. If you make sure your
branch can be merged fast-forward, add <code>--ff</code> to avoid files change.</p>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by spacewander &lt;<a href="&#x6d;&#x61;&#x69;&#108;&#116;&#x6f;&#x3a;&#115;&#112;&#x61;&#99;&#x65;&#119;&#x61;&#110;&#x64;&#x65;&#114;&#108;&#x7a;&#120;&#x40;&#103;&#x6d;&#97;&#x69;&#108;&#x2e;&#x63;&#111;&#109;" data-bare-link="true">&#115;&#x70;&#x61;&#x63;&#x65;&#119;&#97;&#x6e;&#x64;&#x65;&#114;&#108;&#x7a;&#x78;&#64;&#103;&#109;&#97;&#105;&#108;&#46;&#x63;&#111;&#x6d;</a>&gt;</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'>March 2015</li>
<li class='tr'>git-merge-into(1)</li>
</ol>
</div>
</body>
</html>

57
man/git-merge-into.md Normal file
View file

@ -0,0 +1,57 @@
git-merge-into(1) -- Merge one branch into another
=================================
## SYNOPSIS
`git merge-into` [src] &lt;dest&gt; [--ff]
## DESCRIPTION
Merge one branch into another, and keep yourself on current branch. If src branch not given, it will merge current one to dest.
## OPTIONS
&lt;src&gt;
The name of the branch will be merged into. If this not given, use current branch as default.
&lt;dest&gt;
The name of the branch to merge into.
--ff
Try to use `git push` instead of `git merge`. Only work on fast-forward mode.
## EXAMPLES
Assume the following history exists and the current branch is src:
A---B---C src(current)
/
D---E---F---G dest
After running `git merge-into dest`, it will look like this:
A---B---C src(current)
/ \
D---E---F---G---H dest
The `H` commit will record the merge result, just like what `git merge` does.
And `src` is still the current branch.
The default implementation of `merge-into` use `git checkout` and `git merge`,
which may cause temporary change in the working tree. If you make sure your
branch can be merged fast-forward, add `--ff` to avoid files change.
## AUTHOR
Written by spacewander &lt;<spacewanderlzx@gmail.com>&gt;
## REPORTING BUGS
&lt;<https://github.com/tj/git-extras/issues>&gt;
## SEE ALSO
&lt;<https://github.com/tj/git-extras>&gt;