update git-feature docs

This commit is contained in:
spacewander 2015-09-08 13:37:30 +08:00
parent 38c7b03372
commit f6f45990ab
4 changed files with 170 additions and 12 deletions

View file

@ -72,7 +72,7 @@ Sets up the `gh-pages` branch. (See [GitHub Pages](http://pages.github.com/) do
## git feature|refactor|bug|chore
Create the given feature, refactor, bug or chore branch `name`:
Create/Merge the given feature, refactor, bug or chore branch `name`:
```bash
$ git feature dependencies

View file

@ -1,18 +1,24 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-FEATURE" "1" "April 2015" "" ""
.TH "GIT\-FEATURE" "1" "September 2015" "" ""
.
.SH "NAME"
\fBgit\-feature\fR \- Create feature branch
\fBgit\-feature\fR \- Create/Merge feature branch
.
.SH "SYNOPSIS"
\fBgit\-feature\fR [finish] <name>
\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [finish] <name>
.
.SH "DESCRIPTION"
Create the given feature branch
Create/Merge the given feature branch
.
.SH "OPTIONS"
<\-a|\-\-alias branch_prefix>
.
.P
use \fBbranch_prefix\fR instead of \fBfeature\fR
.
.P
<finish>
.
.P
@ -30,10 +36,16 @@ The name of the feature branch\.
$ git feature dependencies
\.\.\.
$ git commit \-m "Some changes"
$ (feature/dependencies) git commit \-m "Some changes"
\.\.\.
$ git checkout master
$ (feature/dependencies) git checkout master
$ git feature finish dependencies
$ git alias features "feature \-a features"
$ git features dependencies
$ (features/dependencies) \.\.\.
$ (features/dependencies) git checkout master
$ git features finish dependencies
.
.fi
.

136
man/git-feature.1.html Normal file
View file

@ -0,0 +1,136 @@
<!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-feature(1) - Create/Merge feature branch</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-feature(1)</li>
<li class='tc'></li>
<li class='tr'>git-feature(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-feature</code> - <span class="man-whatis">Create/Merge feature branch</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-feature</code> [-a|--alias branch_prefix] [finish] &lt;name&gt;</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p> Create/Merge the given feature branch</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p> &lt;-a|--alias branch_prefix&gt;</p>
<p> use <code>branch_prefix</code> instead of <code>feature</code></p>
<p> &lt;finish&gt;</p>
<p> Merge and delete the feature branch.</p>
<p> &lt;name&gt;</p>
<p> The name of the feature branch.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<pre><code>$ git feature dependencies
...
$ (feature/dependencies) git commit -m "Some changes"
...
$ (feature/dependencies) git checkout master
$ git feature finish dependencies
$ git alias features "feature -a features"
$ git features dependencies
$ (features/dependencies) ...
$ (features/dependencies) git checkout master
$ git features finish dependencies
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Jesús Espino &lt;<a href="&#x6d;&#x61;&#x69;&#108;&#116;&#x6f;&#58;&#106;&#x65;&#x73;&#112;&#105;&#110;&#x6f;&#103;&#64;&#103;&#x6d;&#x61;&#x69;&#x6c;&#x2e;&#x63;&#111;&#109;" data-bare-link="true">&#x6a;&#x65;&#x73;&#112;&#105;&#110;&#111;&#x67;&#x40;&#103;&#109;&#x61;&#105;&#108;&#46;&#99;&#111;&#109;</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'>September 2015</li>
<li class='tr'>git-feature(1)</li>
</ol>
</div>
</body>
</html>

View file

@ -1,16 +1,20 @@
git-feature(1) -- Create feature branch
git-feature(1) -- Create/Merge feature branch
=======================================
## SYNOPSIS
`git-feature` [finish] &lt;name&gt;
`git-feature` [-a|--alias branch_prefix] [finish] &lt;name&gt;
## DESCRIPTION
Create the given feature branch
Create/Merge the given feature branch
## OPTIONS
&lt;-a|--alias branch_prefix&gt;
use `branch_prefix` instead of `feature`
&lt;finish&gt;
Merge and delete the feature branch.
@ -23,11 +27,17 @@ git-feature(1) -- Create feature branch
$ git feature dependencies
...
$ git commit -m "Some changes"
$ (feature/dependencies) git commit -m "Some changes"
...
$ git checkout master
$ (feature/dependencies) git checkout master
$ git feature finish dependencies
$ git alias features "feature -a features"
$ git features dependencies
$ (features/dependencies) ...
$ (features/dependencies) git checkout master
$ git features finish dependencies
## AUTHOR
Written by Jesús Espino &lt;<jespinog@gmail.com>&gt;