Skip to content

Commit 9d941e1

Browse files
authored
Merge pull request #569 from nicolaiskogheim/docs/repl-cleanup
git-repl: improve and clean up docs
2 parents a319b6f + 3efe6ab commit 9d941e1

File tree

4 files changed

+128
-37
lines changed

4 files changed

+128
-37
lines changed

Commands.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,21 @@ $ git effort bin/* lib/*
229229

230230
## git repl
231231

232-
GIT read-eval-print-loop:
232+
Git read-eval-print-loop. Let's you run `git` commands without typing 'git'.
233+
234+
Commands can be prefixed with an exclamation mark (!) to be interpreted as
235+
a regular command.
236+
237+
Type `exit` or `quit` to end the repl session.
233238

234239
```bash
235240
$ git repl
241+
git version 2.9.2
242+
git-extras version 3.0.0
243+
type 'ls' to ls files below current directory,
244+
'!command' to execute any command or just 'subcommand' to execute any git subcommand
236245

237-
git> ls-files
246+
git (master)> ls-files
238247
History.md
239248
Makefile
240249
Readme.md
@@ -245,10 +254,11 @@ bin/git-delete-tag
245254
bin/git-ignore
246255
bin/git-release
247256

248-
git> quit
249-
```
257+
git (master)> !echo Straight from the shell!
258+
Straight from the shell!
250259

251-
You can use `exit` instead of `quit`.
260+
git (master)> quit
261+
```
252262

253263
## git commits-since
254264

man/git-repl.1

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "GIT\-REPL" "1" "August 2016" "" ""
4+
.TH "GIT\-REPL" "1" "August 2016" "" "Git Extras"
55
.
66
.SH "NAME"
77
\fBgit\-repl\fR \- git read\-eval\-print\-loop
@@ -10,17 +10,49 @@
1010
\fBgit\-repl\fR
1111
.
1212
.SH "DESCRIPTION"
13+
Git read\-eval\-print\-loop\. Let\'s you run \fBgit\fR commands without typing \'git\'\.
1314
.
14-
.SH "OPTIONS"
15-
GIT read\-eval\-print\-loop:
15+
.P
16+
Commands can be prefixed with an exclamation mark (!) to be interpreted as a regular command\.
17+
.
18+
.P
19+
Type \fBexit\fR or \fBquit\fR to end the repl session\.
20+
.
21+
.SH "COMMANDS"
22+
<command>
1623
.
17-
.IP "" 4
24+
.P
25+
Interpreted as \fBgit <command>\fR\.
26+
.
27+
.P
28+
!<command>
29+
.
30+
.P
31+
Interpreted as \fB<command>\fR (not through \fBgit\fR)\.
32+
.
33+
.P
34+
ls
35+
.
36+
.P
37+
Equivalent of \'git ls\-files\'\.
38+
.
39+
.P
40+
exit|quit
41+
.
42+
.P
43+
Ends the repl session\.
44+
.
45+
.SH "EXAMPLES"
1846
.
1947
.nf
2048

2149
$ git repl
50+
git version 2\.9\.2
51+
git\-extras version 3\.0\.0
52+
type \'ls\' to ls files below current directory,
53+
\'!command\' to execute any command or just \'subcommand\' to execute any git subcommand
2254

23-
git> ls\-files
55+
git (master)> ls\-files
2456
History\.md
2557
Makefile
2658
Readme\.md
@@ -31,17 +63,13 @@ bin/git\-delete\-tag
3163
bin/git\-ignore
3264
bin/git\-release
3365

34-
git> quit
66+
git (master)> !echo Straight from the shell!
67+
Straight from the shell!
68+
69+
git (master)> quit
3570
.
3671
.fi
3772
.
38-
.IP "" 0
39-
.
40-
.P
41-
You can use \fBexit\fR instead of \fBquit\fR\.
42-
.
43-
.SH "EXAMPLES"
44-
.
4573
.SH "AUTHOR"
4674
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>
4775
.

man/git-repl.html

Lines changed: 37 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/git-repl.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,41 @@ git-repl(1) -- git read-eval-print-loop
77

88
## DESCRIPTION
99

10-
## OPTIONS
10+
Git read-eval-print-loop. Let's you run `git` commands without typing 'git'.
1111

12-
GIT read-eval-print-loop:
12+
Commands can be prefixed with an exclamation mark (!) to be interpreted as
13+
a regular command.
14+
15+
Type `exit` or `quit` to end the repl session.
16+
17+
## COMMANDS
18+
19+
&lt;command&gt;
20+
21+
Interpreted as `git <command>`.
22+
23+
!&lt;command&gt;
24+
25+
Interpreted as `<command>` (not through `git`).
26+
27+
ls
28+
29+
Equivalent of 'git ls-files'.
30+
31+
exit|quit
32+
33+
Ends the repl session.
34+
35+
36+
## EXAMPLES
1337

1438
$ git repl
15-
16-
git> ls-files
39+
git version 2.9.2
40+
git-extras version 3.0.0
41+
type 'ls' to ls files below current directory,
42+
'!command' to execute any command or just 'subcommand' to execute any git subcommand
43+
44+
git (master)> ls-files
1745
History.md
1846
Makefile
1947
Readme.md
@@ -23,12 +51,11 @@ git-repl(1) -- git read-eval-print-loop
2351
bin/git-delete-tag
2452
bin/git-ignore
2553
bin/git-release
26-
27-
git> quit
2854

29-
You can use `exit` instead of `quit`.
55+
git (master)> !echo Straight from the shell!
56+
Straight from the shell!
3057

31-
## EXAMPLES
58+
git (master)> quit
3259

3360
## AUTHOR
3461

0 commit comments

Comments
 (0)