git-repl: improve and clean up docs

This commit is contained in:
Nicolai Skogheim 2016-08-12 15:57:26 +02:00
parent a319b6f25e
commit 3efe6ab2df
4 changed files with 128 additions and 37 deletions

View file

@ -229,12 +229,21 @@ $ git effort bin/* lib/*
## git repl
GIT read-eval-print-loop:
Git read-eval-print-loop. Let's you run `git` commands without typing 'git'.
Commands can be prefixed with an exclamation mark (!) to be interpreted as
a regular command.
Type `exit` or `quit` to end the repl session.
```bash
$ git repl
git version 2.9.2
git-extras version 3.0.0
type 'ls' to ls files below current directory,
'!command' to execute any command or just 'subcommand' to execute any git subcommand
git> ls-files
git (master)> ls-files
History.md
Makefile
Readme.md
@ -245,10 +254,11 @@ bin/git-delete-tag
bin/git-ignore
bin/git-release
git> quit
```
git (master)> !echo Straight from the shell!
Straight from the shell!
You can use `exit` instead of `quit`.
git (master)> quit
```
## git commits-since

View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-REPL" "1" "August 2016" "" ""
.TH "GIT\-REPL" "1" "August 2016" "" "Git Extras"
.
.SH "NAME"
\fBgit\-repl\fR \- git read\-eval\-print\-loop
@ -10,17 +10,49 @@
\fBgit\-repl\fR
.
.SH "DESCRIPTION"
Git read\-eval\-print\-loop\. Let\'s you run \fBgit\fR commands without typing \'git\'\.
.
.SH "OPTIONS"
GIT read\-eval\-print\-loop:
.P
Commands can be prefixed with an exclamation mark (!) to be interpreted as a regular command\.
.
.IP "" 4
.P
Type \fBexit\fR or \fBquit\fR to end the repl session\.
.
.SH "COMMANDS"
<command>
.
.P
Interpreted as \fBgit <command>\fR\.
.
.P
!<command>
.
.P
Interpreted as \fB<command>\fR (not through \fBgit\fR)\.
.
.P
ls
.
.P
Equivalent of \'git ls\-files\'\.
.
.P
exit|quit
.
.P
Ends the repl session\.
.
.SH "EXAMPLES"
.
.nf
$ git repl
git version 2\.9\.2
git\-extras version 3\.0\.0
type \'ls\' to ls files below current directory,
\'!command\' to execute any command or just \'subcommand\' to execute any git subcommand
git> ls\-files
git (master)> ls\-files
History\.md
Makefile
Readme\.md
@ -31,17 +63,13 @@ bin/git\-delete\-tag
bin/git\-ignore
bin/git\-release
git> quit
git (master)> !echo Straight from the shell!
Straight from the shell!
git (master)> quit
.
.fi
.
.IP "" 0
.
.P
You can use \fBexit\fR instead of \fBquit\fR\.
.
.SH "EXAMPLES"
.
.SH "AUTHOR"
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>
.

View file

@ -56,7 +56,7 @@
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#COMMANDS">COMMANDS</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
@ -65,7 +65,7 @@
<ol class='man-decor man-head man head'>
<li class='tl'>git-repl(1)</li>
<li class='tc'></li>
<li class='tc'>Git Extras</li>
<li class='tr'>git-repl(1)</li>
</ol>
@ -80,13 +80,40 @@
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<h2 id="OPTIONS">OPTIONS</h2>
<p> Git read-eval-print-loop. Let's you run <code>git</code> commands without typing 'git'.</p>
<p> GIT read-eval-print-loop:</p>
<p> Commands can be prefixed with an exclamation mark (!) to be interpreted as
a regular command.</p>
<p> Type <code>exit</code> or <code>quit</code> to end the repl session.</p>
<h2 id="COMMANDS">COMMANDS</h2>
<p> &lt;command&gt;</p>
<p> Interpreted as <code>git &lt;command></code>.</p>
<p> !&lt;command&gt;</p>
<p> Interpreted as <code>&lt;command></code> (not through <code>git</code>).</p>
<p> ls</p>
<p> Equivalent of 'git ls-files'.</p>
<p> exit|quit</p>
<p> Ends the repl session.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<pre><code>$ git repl
git version 2.9.2
git-extras version 3.0.0
type 'ls' to ls files below current directory,
'!command' to execute any command or just 'subcommand' to execute any git subcommand
git&gt; ls-files
git (master)&gt; ls-files
History.md
Makefile
Readme.md
@ -97,16 +124,15 @@ bin/git-delete-tag
bin/git-ignore
bin/git-release
git&gt; quit
git (master)&gt; !echo Straight from the shell!
Straight from the shell!
git (master)&gt; quit
</code></pre>
<p> You can use <code>exit</code> instead of <code>quit</code>.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Tj Holowaychuk &lt;<a href="&#x6d;&#x61;&#x69;&#x6c;&#116;&#x6f;&#58;&#116;&#x6a;&#x40;&#118;&#x69;&#115;&#x69;&#x6f;&#x6e;&#45;&#x6d;&#x65;&#x64;&#x69;&#97;&#46;&#x63;&#x61;" data-bare-link="true">&#116;&#106;&#x40;&#118;&#x69;&#115;&#x69;&#111;&#x6e;&#45;&#109;&#x65;&#100;&#105;&#97;&#46;&#x63;&#x61;</a>&gt;</p>
<p>Written by Tj Holowaychuk &lt;<a href="&#x6d;&#x61;&#105;&#108;&#x74;&#111;&#58;&#x74;&#106;&#64;&#118;&#105;&#x73;&#105;&#111;&#x6e;&#45;&#x6d;&#x65;&#x64;&#105;&#x61;&#x2e;&#x63;&#97;" data-bare-link="true">&#x74;&#x6a;&#x40;&#118;&#x69;&#115;&#x69;&#111;&#110;&#45;&#x6d;&#101;&#100;&#x69;&#97;&#46;&#x63;&#x61;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

View file

@ -7,13 +7,41 @@ git-repl(1) -- git read-eval-print-loop
## DESCRIPTION
## OPTIONS
Git read-eval-print-loop. Let's you run `git` commands without typing 'git'.
GIT read-eval-print-loop:
Commands can be prefixed with an exclamation mark (!) to be interpreted as
a regular command.
Type `exit` or `quit` to end the repl session.
## COMMANDS
&lt;command&gt;
Interpreted as `git <command>`.
!&lt;command&gt;
Interpreted as `<command>` (not through `git`).
ls
Equivalent of 'git ls-files'.
exit|quit
Ends the repl session.
## EXAMPLES
$ git repl
git> ls-files
git version 2.9.2
git-extras version 3.0.0
type 'ls' to ls files below current directory,
'!command' to execute any command or just 'subcommand' to execute any git subcommand
git (master)> ls-files
History.md
Makefile
Readme.md
@ -23,12 +51,11 @@ git-repl(1) -- git read-eval-print-loop
bin/git-delete-tag
bin/git-ignore
bin/git-release
git> quit
You can use `exit` instead of `quit`.
git (master)> !echo Straight from the shell!
Straight from the shell!
## EXAMPLES
git (master)> quit
## AUTHOR