mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 07:26:17 -04:00
Add documentation.
This commit is contained in:
Rémy HUBSCHER
parent
3039f9405e
commit
84699acc6e
24
Commands.md
24
Commands.md
|
|
@ -42,6 +42,7 @@
|
|||
- [`git root`](#git-root)
|
||||
- [`git delta`](#git-delta)
|
||||
- [`git merge-repo`](#git-merge-repo)
|
||||
- [`git psykorebase`](#git-psykorebase)
|
||||
|
||||
## git extras
|
||||
|
||||
|
|
@ -853,3 +854,26 @@ $ git merge-repo git@github.com:tj/git-extras.git master .
|
|||
```
|
||||
|
||||
The above merges a remote repo's `master` branch into the current repository's directory, not preserving history.
|
||||
|
||||
|
||||
## git psykorebase
|
||||
|
||||
Rebase a branch on top of another using a merge commit and only one conflict handling.
|
||||
|
||||
```bash
|
||||
$ git psykorebase master
|
||||
```
|
||||
|
||||
The above rebase the current branch on top of `master` branch .
|
||||
|
||||
```bash
|
||||
$ git psykorebase --continue
|
||||
```
|
||||
|
||||
The above continue the rebase after conflicts have been handled.
|
||||
|
||||
```bash
|
||||
$ git psykorebase master feature
|
||||
```
|
||||
|
||||
The above rebase `feature` branch on top of `master` branch
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ function current_branch() {
|
|||
|
||||
function usage()
|
||||
{
|
||||
echo "USAGE: ${PROGRAM} PRIMARY_BRANCH [SECONDARY_BRANCH]"
|
||||
echo "USAGE: ${PROGRAM} PRIMARY_BRANCH [SECONDARY_BRANCH] [--no-ff]"
|
||||
echo "USAGE: ${PROGRAM} --continue"
|
||||
echo ""
|
||||
echo "OPTIONS:"
|
||||
|
|
|
|||
67
man/git-psykorebase.1
Normal file
67
man/git-psykorebase.1
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "GIT\-PSYKOREBASE" "1" "August 2015" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBgit\-psykorebase\fR \- Rebase a branch with a merge commit
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBgit\-psykorebase\fR <target_branch> [<feature_branch>] [\-\-no\-ff] \fBgit\-psykorebase\fR \-\-continue
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
Rebase the \fBfeature_branch\fR on top of the \fBtarget_branch\fR, the \fBfeature_branch\fR defaults to the current one\.
|
||||
.
|
||||
.SH "OPTIONS"
|
||||
\fB\-\-no\-ff\fR Force a commit message even if there are no conflicts\. \fB\-\-continue\fR Continue the rebase after conflicts have been resolved\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Rebase current branch on top of master:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ git psykorebase master \-\-no\-ff
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Handle conflicts:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ git add README\.md
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Continue rebase:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ git psykorebase \-\-continue
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "AUTHOR"
|
||||
Written by Rémy Hubscher <\fIrhubscher@mozilla\.com\fR>
|
||||
.
|
||||
.P
|
||||
Based on Benoît Bryon <\fIbenoit@marmelune\.net\fR> implementation in Python\.
|
||||
.
|
||||
.SH "REPORTING BUGS"
|
||||
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
<\fIhttps://github\.com/tj/git\-extras\fR> <\fIhttps://github\.com/benoitbryon/psykorebase\fR>
|
||||
134
man/git-psykorebase.html
Normal file
134
man/git-psykorebase.html
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
<!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-psykorebase(1) - Rebase a branch with a merge commit</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-psykorebase(1)</li>
|
||||
<li class='tc'></li>
|
||||
<li class='tr'>git-psykorebase(1)</li>
|
||||
</ol>
|
||||
|
||||
<h2 id="NAME">NAME</h2>
|
||||
<p class="man-name">
|
||||
<code>git-psykorebase</code> - <span class="man-whatis">Rebase a branch with a merge commit</span>
|
||||
</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<p><code>git-psykorebase</code> <target_branch> [<feature_branch>] [--no-ff]
|
||||
<code>git-psykorebase</code> --continue</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<p>Rebase the <code>feature_branch</code> on top of the <code>target_branch</code>, the
|
||||
<code>feature_branch</code> defaults to the current one.</p>
|
||||
|
||||
<h2 id="OPTIONS">OPTIONS</h2>
|
||||
|
||||
<p> <code>--no-ff</code> Force a commit message even if there are no conflicts.
|
||||
<code>--continue</code> Continue the rebase after conflicts have been resolved.</p>
|
||||
|
||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
||||
|
||||
<p> Rebase current branch on top of master:</p>
|
||||
|
||||
<pre><code>$ git psykorebase master --no-ff
|
||||
</code></pre>
|
||||
|
||||
<p> Handle conflicts:</p>
|
||||
|
||||
<pre><code>$ git add README.md
|
||||
</code></pre>
|
||||
|
||||
<p> Continue rebase:</p>
|
||||
|
||||
<pre><code>$ git psykorebase --continue
|
||||
</code></pre>
|
||||
|
||||
<h2 id="AUTHOR">AUTHOR</h2>
|
||||
|
||||
<p>Written by Rémy Hubscher <<a href="mailto:rhubscher@mozilla.com" data-bare-link="true">rhubscher@mozilla.com</a>></p>
|
||||
|
||||
<p>Based on Benoît Bryon <<a href="mailto:benoit@marmelune.net" data-bare-link="true">benoit@marmelune.net</a>> implementation in
|
||||
Python.</p>
|
||||
|
||||
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
||||
|
||||
<p><<a href="https://github.com/tj/git-extras/issues" data-bare-link="true">https://github.com/tj/git-extras/issues</a>></p>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<p><<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>>
|
||||
<<a href="https://github.com/benoitbryon/psykorebase" data-bare-link="true">https://github.com/benoitbryon/psykorebase</a>></p>
|
||||
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'></li>
|
||||
<li class='tc'>August 2015</li>
|
||||
<li class='tr'>git-psykorebase(1)</li>
|
||||
</ol>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
47
man/git-psykorebase.md
Normal file
47
man/git-psykorebase.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
git-psykorebase(1) -- Rebase a branch with a merge commit
|
||||
=========================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
`git-psykorebase` <target_branch> [<feature_branch>] [--no-ff]
|
||||
`git-psykorebase` --continue
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Rebase the `feature_branch` on top of the `target_branch`, the
|
||||
`feature_branch` defaults to the current one.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
`--no-ff` Force a commit message even if there are no conflicts.
|
||||
`--continue` Continue the rebase after conflicts have been resolved.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
Rebase current branch on top of master:
|
||||
|
||||
$ git psykorebase master --no-ff
|
||||
|
||||
Handle conflicts:
|
||||
|
||||
$ git add README.md
|
||||
|
||||
Continue rebase:
|
||||
|
||||
$ git psykorebase --continue
|
||||
|
||||
## AUTHOR
|
||||
|
||||
Written by Rémy Hubscher <<rhubscher@mozilla.com>>
|
||||
|
||||
Based on Benoît Bryon <<benoit@marmelune.net>> implementation in
|
||||
Python.
|
||||
|
||||
## REPORTING BUGS
|
||||
|
||||
<<https://github.com/tj/git-extras/issues>>
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
<<https://github.com/tj/git-extras>>
|
||||
<<https://github.com/benoitbryon/psykorebase>>
|
||||
Loading…
Reference in a new issue