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

updated git-feature documentation

Browse source
This commit is contained in:
Carlos Prado 2020-04-05 02:43:25 +02:00
parent c038741194
commit 45eed8f166
3 changed files with 130 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
man/git-feature.1
View file

@ -7,7 +7,10 @@
\fBgit\-feature\fR \- Create/Merge feature branch
.
.SH "SYNOPSIS"
\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [\-r|\-\-remote [remote_name]] [finish] <name>
\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [\-r|\-\-remote [remote_name]] <name>
.
.br
\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] finish [\-\-squash] <name>
.
.SH "DESCRIPTION"
Create/Merge the given feature branch
@ -25,18 +28,18 @@ use \fBbranch_prefix\fR instead of \fBfeature\fR
Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\.
.
.P
<\-\-squash>
.
.P
Run a squash merge\.
.
.P
<finish>
.
.P
Merge and delete the feature branch\.
.
.P
<\-\-squash>
.
.P
Run a squash merge\.
.
.P
<name>
.
.P
@ -44,24 +47,59 @@ The name of the feature branch\.
.
.SH "EXAMPLES"
.
.nf
.TP
Start a new feature:
.
.IP
$ git feature dependencies
\.\.\.
.
.br
\&\.\.\.
.
.br
$ (feature/dependencies) git commit \-m "Some changes"
\.\.\.
.
.TP
Finish a feature with \-\-no\-ff merge:
.
.IP
$ (feature/dependencies) git checkout master
.
.br
$ git feature finish dependencies
$ git alias features "feature \-a features"
$ git features dependencies
$ (features/dependencies) \.\.\.
$ (features/dependencies) git checkout master
$ git features finish \-\-squash dependencies
.
.TP
Finish a feature with \-\-squash merge:
.
.IP
$ (feature/dependencies) git checkout master
.
.br
$ git feature finish \-\-squash dependencies
.
.TP
Publish a feature upstream:
.
.IP
$ git feature dependencies \-r upstream
.
.fi
.TP
Use custom branch prefix:
.
.IP
$ git alias features "feature \-a features"
.
.br
$ git features dependencies
.
.br
$ (features/dependencies) \.\.\.
.
.br
$ (features/dependencies) git checkout master
.
.br
$ git features finish dependencies
.
.SH "AUTHOR"
Written by Jesús Espino <\fIjespinog@gmail\.com\fR>
@ -69,6 +107,9 @@ Written by Jesús Espino <\fIjespinog@gmail\.com\fR>
.br
Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR>
.
.br
Modified by Carlos Prado <\fIcarlos\.prado@cpradog\.com\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.

53
man/git-feature.html
View file

@ -76,7 +76,8 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-feature</code> [-a|--alias branch_prefix] [-r|--remote [remote_name]] [finish] &lt;name&gt;</p>
<p><code>git-feature</code> [-a|--alias branch_prefix] [-r|--remote [remote_name]] &lt;name&gt;<br />
<code>git-feature</code> [-a|--alias branch_prefix] finish [--squash] &lt;name&gt;</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@ -92,40 +93,52 @@
<p> Setup a remote tracking branch using <code>remote_name</code>. If <code>remote_name</code> is not supplied, use <code>origin</code> by default.</p>
<p> &lt;--squash&gt;</p>
<p> Run a squash merge.</p>
<p> &lt;finish&gt;</p>
<p> Merge and delete the feature branch.</p>
<p> &lt;--squash&gt;</p>
<p> Run a squash merge.</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
<dl>
<dt>Start a new feature:</dt><dd><p></p>
$ git alias features "feature -a features"
$ git features dependencies
$ (features/dependencies) ...
$ (features/dependencies) git checkout master
$ git features finish --squash dependencies
<p>$ git feature dependencies<br />
...<br />
$ (feature/dependencies) git commit -m "Some changes"</p></dd>
<dt>Finish a feature with --no-ff merge:</dt><dd><p></p>
<p>$ (feature/dependencies) git checkout master<br />
$ git feature finish dependencies</p></dd>
<dt>Finish a feature with --squash merge:</dt><dd><p></p>
<p>$ (feature/dependencies) git checkout master<br />
$ git feature finish --squash dependencies</p></dd>
<dt>Publish a feature upstream:</dt><dd><p></p>
<p>$ git feature dependencies -r upstream</p></dd>
<dt>Use custom branch prefix:</dt><dd><p></p>
<p>$ git alias features "feature -a features"<br />
$ git features dependencies<br />
$ (features/dependencies) ...<br />
$ (features/dependencies) git checkout master<br />
$ git features finish dependencies</p></dd>
</dl>
$ git feature dependencies -r upstream
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Jesús Espino &lt;<a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#x3a;&#106;&#x65;&#115;&#112;&#x69;&#x6e;&#111;&#103;&#x40;&#103;&#109;&#97;&#x69;&#108;&#46;&#99;&#x6f;&#109;" data-bare-link="true">&#106;&#x65;&#x73;&#x70;&#105;&#x6e;&#x6f;&#103;&#64;&#103;&#x6d;&#x61;&#x69;&#108;&#46;&#x63;&#111;&#x6d;</a>&gt;<br />
Modified by Mark Pitman &lt;<a href="&#x6d;&#x61;&#105;&#108;&#x74;&#111;&#58;&#x6d;&#97;&#114;&#x6b;&#x2e;&#x70;&#x69;&#x74;&#109;&#97;&#x6e;&#x40;&#103;&#x6d;&#x61;&#105;&#x6c;&#46;&#x63;&#x6f;&#109;" data-bare-link="true">&#x6d;&#x61;&#114;&#107;&#46;&#112;&#105;&#116;&#109;&#97;&#x6e;&#64;&#103;&#109;&#97;&#x69;&#x6c;&#x2e;&#99;&#x6f;&#109;</a>&gt;</p>
<p>Written by Jesús Espino &lt;<a href="&#x6d;&#x61;&#105;&#108;&#116;&#x6f;&#58;&#x6a;&#x65;&#115;&#112;&#105;&#x6e;&#111;&#103;&#64;&#x67;&#109;&#x61;&#105;&#108;&#x2e;&#99;&#111;&#109;" data-bare-link="true">&#x6a;&#101;&#x73;&#x70;&#x69;&#x6e;&#x6f;&#103;&#64;&#x67;&#109;&#x61;&#x69;&#108;&#46;&#x63;&#111;&#x6d;</a>&gt;<br />
Modified by Mark Pitman &lt;<a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#58;&#x6d;&#97;&#x72;&#x6b;&#46;&#x70;&#x69;&#116;&#x6d;&#97;&#x6e;&#64;&#x67;&#x6d;&#97;&#x69;&#108;&#x2e;&#99;&#111;&#109;" data-bare-link="true">&#109;&#97;&#x72;&#107;&#46;&#112;&#x69;&#x74;&#109;&#x61;&#110;&#64;&#103;&#x6d;&#97;&#105;&#108;&#46;&#x63;&#x6f;&#109;</a>&gt;<br />
Modified by Carlos Prado &lt;<a href="&#x6d;&#97;&#x69;&#108;&#x74;&#x6f;&#x3a;&#99;&#x61;&#x72;&#108;&#x6f;&#115;&#46;&#x70;&#x72;&#x61;&#100;&#x6f;&#64;&#99;&#x70;&#x72;&#97;&#x64;&#x6f;&#103;&#x2e;&#99;&#x6f;&#x6d;" data-bare-link="true">&#x63;&#97;&#x72;&#x6c;&#x6f;&#115;&#x2e;&#x70;&#114;&#97;&#x64;&#x6f;&#x40;&#99;&#x70;&#114;&#x61;&#x64;&#x6f;&#103;&#46;&#99;&#x6f;&#109;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

54
man/git-feature.md
View file

@ -3,7 +3,8 @@ git-feature(1) -- Create/Merge feature branch
## SYNOPSIS
`git-feature` [-a|--alias branch_prefix] [-r|--remote [remote_name]] [finish] &lt;name&gt;
`git-feature` [-a|--alias branch_prefix] [-r|--remote [remote_name]] &lt;name&gt;
`git-feature` [-a|--alias branch_prefix] finish [--squash] &lt;name&gt;
## DESCRIPTION
@ -19,39 +20,58 @@ git-feature(1) -- Create/Merge feature branch
Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default.
&lt;--squash&gt;
Run a squash merge.
&lt;finish&gt;
Merge and delete the feature branch.
&lt;--squash&gt;
Run a squash merge.
&lt;name&gt;
The name of the feature branch.
## EXAMPLES
$ git feature dependencies
...
$ (feature/dependencies) git commit -m "Some changes"
...
$ (feature/dependencies) git checkout master
* Start a new feature:
$ git feature dependencies
...
$ (feature/dependencies) git commit -m "Some changes"
* Finish a feature with --no-ff merge:
$ (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 --squash dependencies
* Finish a feature with --squash merge:
$ git feature dependencies -r upstream
$ (feature/dependencies) git checkout master
$ git feature finish --squash dependencies
* Publish a feature upstream:
$ git feature dependencies -r upstream
* Use custom branch prefix:
$ 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;
Modified by Mark Pitman &lt;<mark.pitman@gmail.com>&gt;
Modified by Mark Pitman &lt;<mark.pitman@gmail.com>&gt;
Modified by Carlos Prado &lt;<carlos.prado@cpradog.com>&gt;
## REPORTING BUGS