Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git-repl: improve and clean up docs #569

Merged
merged 1 commit into from
Aug 13, 2016
Merged

git-repl: improve and clean up docs #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions Commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
54 changes: 41 additions & 13 deletions man/git-repl.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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\.
.
.P
Type \fBexit\fR or \fBquit\fR to end the repl session\.
.
.SH "COMMANDS"
<command>
.
.IP "" 4
.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
Expand All @@ -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>
.
Expand Down
48 changes: 37 additions & 11 deletions man/git-repl.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 35 additions & 8 deletions man/git-repl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down