mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 07:26:17 -04:00
documentation for git-alias
This commit is contained in:
Jonhnny Weslley
parent
f3fb2dda61
commit
ae511e0ef0
85
Readme.md
85
Readme.md
|
|
@ -29,6 +29,7 @@ Brew (buggy):
|
|||
- git delete-tag
|
||||
- git fresh-branch
|
||||
- git graft
|
||||
- git alias
|
||||
- git ignore
|
||||
- git release
|
||||
- git contrib
|
||||
|
|
@ -57,28 +58,28 @@ Outputs a repo summary:
|
|||
|
||||
$ git summary
|
||||
|
||||
project: express
|
||||
commits: 1893
|
||||
files : 111
|
||||
authors:
|
||||
1285 visionmedia
|
||||
478 Tj Holowaychuk
|
||||
48 Aaron Heckmann
|
||||
34 csausdev
|
||||
26 ciaranj
|
||||
project: express
|
||||
commits: 1893
|
||||
files : 111
|
||||
authors:
|
||||
1285 visionmedia
|
||||
478 Tj Holowaychuk
|
||||
48 Aaron Heckmann
|
||||
34 csausdev
|
||||
26 ciaranj
|
||||
6 Guillermo Rauch
|
||||
3 Nick Poulden
|
||||
2 Brian McKinney
|
||||
2 Benny Wong
|
||||
1 Justin Lilly
|
||||
1 James Herdman
|
||||
1 Adam Sanderson
|
||||
1 Viktor Kelemen
|
||||
1 Gregory Ritter
|
||||
1 Greg Ritter
|
||||
1 ewoudj
|
||||
1 isaacs
|
||||
1 Matt Colyer
|
||||
3 Nick Poulden
|
||||
2 Brian McKinney
|
||||
2 Benny Wong
|
||||
1 Justin Lilly
|
||||
1 James Herdman
|
||||
1 Adam Sanderson
|
||||
1 Viktor Kelemen
|
||||
1 Gregory Ritter
|
||||
1 Greg Ritter
|
||||
1 ewoudj
|
||||
1 isaacs
|
||||
1 Matt Colyer
|
||||
|
||||
This command can also take a commitish, and will print a summary for the range
|
||||
of commits included in the commitish:
|
||||
|
|
@ -90,7 +91,7 @@ of commits included in the commitish:
|
|||
GIT read-eval-print-loop:
|
||||
|
||||
$ git repl
|
||||
|
||||
|
||||
git> ls-files
|
||||
History.md
|
||||
Makefile
|
||||
|
|
@ -101,7 +102,7 @@ of commits included in the commitish:
|
|||
bin/git-delete-tag
|
||||
bin/git-ignore
|
||||
bin/git-release
|
||||
|
||||
|
||||
git> quit
|
||||
|
||||
## git-commits-since [date]
|
||||
|
|
@ -155,15 +156,37 @@ of commits included in the commitish:
|
|||
## git-release
|
||||
|
||||
Release commit with the given <tag>.
|
||||
|
||||
|
||||
$ git release 0.1.0
|
||||
|
||||
|
||||
Does the following:
|
||||
|
||||
- Commits changes (to changelog etc) with message "Release <tag>"
|
||||
- Tags with the given <tag>
|
||||
- Pushes the branch / tags
|
||||
|
||||
## git-alias
|
||||
|
||||
Define, search and show aliases.
|
||||
|
||||
Defining a new alias:
|
||||
|
||||
$ git alias last "cat-file commit HEAD"
|
||||
|
||||
Providing only one argument, `git-alias` searchs for aliases matching the given value:
|
||||
|
||||
$ git alias ^la
|
||||
last = cat-file commit HEAD
|
||||
|
||||
`git-alias` will show all aliases if no argument is given:
|
||||
|
||||
$ git alias
|
||||
s = status
|
||||
amend = commit --amend
|
||||
rank = shortlog -sn --no-merges
|
||||
whatis = show -s --pretty='tformat:%h (%s, %ad)' --date=short
|
||||
whois = !sh -c 'git log -i -1 --pretty="format:%an <%ae>
|
||||
|
||||
## git-ignore
|
||||
|
||||
To lazy to open up _.gitignore_? me too! simply pass some patterns:
|
||||
|
|
@ -177,7 +200,7 @@ of commits included in the commitish:
|
|||
$ git ignore
|
||||
build
|
||||
*.o
|
||||
*.log
|
||||
*.log
|
||||
|
||||
## git-create-branch <name>
|
||||
|
||||
|
|
@ -222,10 +245,10 @@ of commits included in the commitish:
|
|||
since the previous tag or since the project began when no tags are present. Opens the changelog in **$EDITOR** when set.
|
||||
|
||||
$ git changelog && cat History.md
|
||||
|
||||
n.n.n / 2010-08-05
|
||||
|
||||
n.n.n / 2010-08-05
|
||||
==================
|
||||
|
||||
|
||||
* Docs for git-ignore. Closes #3
|
||||
* Merge branch 'ignore'
|
||||
* Added git-ignore
|
||||
|
|
@ -236,9 +259,9 @@ since the previous tag or since the project began when no tags are present. Open
|
|||
* Passing args to git shortlog
|
||||
* Added --all support to git-count
|
||||
* Initial commit
|
||||
|
||||
|
||||
Listing commits:
|
||||
|
||||
|
||||
$ git changelog --list
|
||||
|
||||
* Docs for git-ignore. Closes #3
|
||||
|
|
|
|||
84
man/git-alias.1
Normal file
84
man/git-alias.1
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "GIT\-ALIAS" "1" "March 2011" "" "Git Extras"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBgit\-alias\fR \- Define, search and show aliases
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBgit\-alias\fR [<alias\-name> <command>]|[<search\-term>]
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
.
|
||||
.SH "OPTIONS"
|
||||
<alias\-name>
|
||||
.
|
||||
.P
|
||||
The name of the alias to create\.
|
||||
.
|
||||
.P
|
||||
<command>
|
||||
.
|
||||
.P
|
||||
The command for which you are creating an alias\.
|
||||
.
|
||||
.P
|
||||
<search\-term>
|
||||
.
|
||||
.P
|
||||
The pattern used for search aliases\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Defining a new alias:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ git alias last "cat\-file commit HEAD"
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Providing only one argument, \fBgit\-alias\fR searchs for aliases matching the given value:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ git alias ^la
|
||||
last = cat\-file commit HEAD
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
\fBgit\-alias\fR will show all aliases if no argument is given:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ git alias
|
||||
s = status
|
||||
amend = commit \-\-amend
|
||||
rank = shortlog \-sn \-\-no\-merges
|
||||
whatis = show \-s \-\-pretty=\'tformat:%h (%s, %ad)\' \-\-date=short
|
||||
whois = !sh \-c \'git log \-i \-1 \-\-pretty="format:%an <%ae>
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "AUTHOR"
|
||||
Written by Jonhnny Weslley <\fIjw@jonhnnyweslley\.net\fR>
|
||||
.
|
||||
.SH "REPORTING BUGS"
|
||||
<\fIhttp://github\.com/visionmedia/git\-extras/issues\fR>
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
<\fIhttp://github\.com/visionmedia/git\-extras\fR>
|
||||
141
man/git-alias.1.html
Normal file
141
man/git-alias.1.html
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
<!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-alias(1) - Define, search and show aliases</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-alias(1)</li>
|
||||
<li class='tc'>Git Extras</li>
|
||||
<li class='tr'>git-alias(1)</li>
|
||||
</ol>
|
||||
|
||||
<h2 id="NAME">NAME</h2>
|
||||
<p class="man-name">
|
||||
<code>git-alias</code> - <span class="man-whatis">Define, search and show aliases</span>
|
||||
</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<p><code>git-alias</code> [<alias-name> <command>]|[<search-term>]</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="OPTIONS">OPTIONS</h2>
|
||||
|
||||
<p> <alias-name></p>
|
||||
|
||||
<p> The name of the alias to create.</p>
|
||||
|
||||
<p> <command></p>
|
||||
|
||||
<p> The command for which you are creating an alias.</p>
|
||||
|
||||
<p> <search-term></p>
|
||||
|
||||
<p> The pattern used for search aliases.</p>
|
||||
|
||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
||||
|
||||
<p> Defining a new alias:</p>
|
||||
|
||||
<pre><code>$ git alias last "cat-file commit HEAD"
|
||||
</code></pre>
|
||||
|
||||
<p> Providing only one argument, <code>git-alias</code> searchs for aliases matching the given value:</p>
|
||||
|
||||
<pre><code>$ git alias ^la
|
||||
last = cat-file commit HEAD
|
||||
</code></pre>
|
||||
|
||||
<p> <code>git-alias</code> will show all aliases if no argument is given:</p>
|
||||
|
||||
<pre><code>$ git alias
|
||||
s = status
|
||||
amend = commit --amend
|
||||
rank = shortlog -sn --no-merges
|
||||
whatis = show -s --pretty='tformat:%h (%s, %ad)' --date=short
|
||||
whois = !sh -c 'git log -i -1 --pretty="format:%an <%ae>
|
||||
</code></pre>
|
||||
|
||||
<h2 id="AUTHOR">AUTHOR</h2>
|
||||
|
||||
<p>Written by Jonhnny Weslley <<a href="mailto:jw@jonhnnyweslley.net" data-bare-link="true">jw@jonhnnyweslley.net</a>></p>
|
||||
|
||||
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
||||
|
||||
<p><<a href="http://github.com/visionmedia/git-extras/issues" data-bare-link="true">http://github.com/visionmedia/git-extras/issues</a>></p>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<p><<a href="http://github.com/visionmedia/git-extras" data-bare-link="true">http://github.com/visionmedia/git-extras</a>></p>
|
||||
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'></li>
|
||||
<li class='tc'>March 2011</li>
|
||||
<li class='tr'>git-alias(1)</li>
|
||||
</ol>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
56
man/git-alias.md
Normal file
56
man/git-alias.md
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
git-alias(1) -- Define, search and show aliases
|
||||
===============================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
`git-alias` [<alias-name> <command>]|[<search-term>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
||||
## OPTIONS
|
||||
|
||||
<alias-name>
|
||||
|
||||
The name of the alias to create.
|
||||
|
||||
<command>
|
||||
|
||||
The command for which you are creating an alias.
|
||||
|
||||
<search-term>
|
||||
|
||||
The pattern used for search aliases.
|
||||
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
Defining a new alias:
|
||||
|
||||
$ git alias last "cat-file commit HEAD"
|
||||
|
||||
Providing only one argument, `git-alias` searchs for aliases matching the given value:
|
||||
|
||||
$ git alias ^la
|
||||
last = cat-file commit HEAD
|
||||
|
||||
`git-alias` will show all aliases if no argument is given:
|
||||
|
||||
$ git alias
|
||||
s = status
|
||||
amend = commit --amend
|
||||
rank = shortlog -sn --no-merges
|
||||
whatis = show -s --pretty='tformat:%h (%s, %ad)' --date=short
|
||||
whois = !sh -c 'git log -i -1 --pretty="format:%an <%ae>
|
||||
|
||||
## AUTHOR
|
||||
|
||||
Written by Jonhnny Weslley <<jw@jonhnnyweslley.net>>
|
||||
|
||||
## REPORTING BUGS
|
||||
|
||||
<<http://github.com/visionmedia/git-extras/issues>>
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
<<http://github.com/visionmedia/git-extras>>
|
||||
Loading…
Reference in a new issue