Merge pull request #113 from muhtasib/git_info

Updated main documentation to include git-info
This commit is contained in:
TJ Holowaychuk 2012-06-16 13:20:34 -07:00
commit d58c8cff42
4 changed files with 57 additions and 1 deletions

View file

@ -45,6 +45,7 @@ $ brew install git-extras
- `git graft`
- `git alias`
- `git ignore`
- `git info`
- `git release`
- `git contrib`
- `git repl`
@ -327,6 +328,56 @@ build
*.log
```
# git-info
Show information about the repo:
```bash
$ git info
## Remote URLs:
origin git@github.com:sampleAuthor/git-extras.git (fetch)
origin git@github.com:sampleAuthor/git-extras.git (push)
## Remote Branches:
origin/HEAD -> origin/master
origin/myBranch
## Local Branches:
myBranch
* master
## Most Recent Commit:
commit e3952df2c172c6f3eb533d8d0b1a6c77250769a7
Author: Sample Author <sampleAuthor@gmail.com>
Added git-info command.
Type 'git log' for more commits, or 'git show <commit id>' for full commit details.
## Configuration (.git/config):
color.diff=auto
color.status=auto
color.branch=auto
user.name=Sample Author
user.email=sampleAuthor@gmail.com
core.repositoryformatversion=0
core.filemode=true
core.bare=false
core.logallrefupdates=true
core.ignorecase=true
remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
remote.origin.url=git@github.com:mub/git-extras.git
branch.master.remote=origin
branch.master.merge=refs/heads/master
```
## git-create-branch &lt;name&gt;
Create local and remote branch `name`:

View file

@ -53,6 +53,9 @@
.IP "\(bu" 4
\fBgit\-undo\fR undo one or more of the latest commits
.
.IP "\(bu" 4
\fBgit\-info\fR show information about the repository
.
.IP "" 0
.
.SH "AUTHOR"

View file

@ -93,12 +93,13 @@
<li> <code>git-summary</code> repository summary &amp; contrib</li>
<li> <code>git-touch</code> touch and add file to the index</li>
<li> <code>git-undo</code> undo one or more of the latest commits</li>
<li> <code>git-info</code> show information about the repository</li>
</ul>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Tj Holowaychuk &lt;<a data-bare-link="true" href="&#109;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#116;&#x6a;&#x40;&#118;&#105;&#x73;&#x69;&#x6f;&#x6e;&#x2d;&#109;&#x65;&#100;&#x69;&#x61;&#46;&#x63;&#x61;">&#116;&#x6a;&#x40;&#x76;&#x69;&#x73;&#105;&#111;&#x6e;&#45;&#109;&#101;&#x64;&#105;&#x61;&#x2e;&#x63;&#97;</a>&gt;</p>
<p>Written by Tj Holowaychuk &lt;<a data-bare-link="true" href="&#109;&#97;&#x69;&#x6c;&#116;&#111;&#x3a;&#x74;&#x6a;&#x40;&#118;&#105;&#x73;&#x69;&#x6f;&#x6e;&#x2d;&#x6d;&#x65;&#x64;&#x69;&#97;&#46;&#x63;&#97;">&#x74;&#106;&#64;&#118;&#105;&#115;&#105;&#111;&#x6e;&#x2d;&#109;&#x65;&#100;&#105;&#97;&#x2e;&#99;&#x61;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

View file

@ -21,6 +21,7 @@ git-extras(1) -- Awesome GIT utilities
- `git-summary` repository summary & contrib
- `git-touch` touch and add file to the index
- `git-undo` undo one or more of the latest commits
- `git-info` show information about the repository
## AUTHOR