Update documentation for :Git

This commit is contained in:
Tim Pope
2021-08-20 17:01:57 -04:00
parent 66a070ab14
commit 7e53b2aef9

View File

@@ -15,9 +15,12 @@ COMMANDS *fugitive-commands*
These commands are local to the buffers in which they work (generally, buffers These commands are local to the buffers in which they work (generally, buffers
that are part of Git repositories). that are part of Git repositories).
*:Git* *fugitive-:G* *fugitive-:G*
:G [args] Same as :Git, but two characters shorter.
*:Git*
:Git {args} Run an arbitrary git command and display any output. :Git {args} Run an arbitrary git command and display any output.
:G {args} On UNIX this uses a pty and on other platforms it uses On UNIX this uses a pty and on other platforms it uses
a pipe, which will cause some behavior differences a pipe, which will cause some behavior differences
such as the absence of progress bars. Any file the such as the absence of progress bars. Any file the
command edits (for example, a commit message) will be command edits (for example, a commit message) will be
@@ -25,17 +28,28 @@ that are part of Git repositories).
resume running the command. A few Git subcommands resume running the command. A few Git subcommands
have different behavior; these are documented below. have different behavior; these are documented below.
*:Git!*
:Git! {args} Run an arbitrary git command in the background and
stream the output to the preview window. Requires a
Vim with |setbufline()|. Press CTRL-D during an
interactive :Git invocation to switch to this mode
retroactively.
*:Git_--paginate* *:Git_-p* *:Git_--paginate* *:Git_-p*
:Git --paginate {args} Run an arbitrary git command, capture output to a temp :Git --paginate {args} Run an arbitrary git command, capture output to a temp
:Git -p {args} file, and |:split| that temp file. Use :0Git to :Git -p {args} file, and |:split| that temp file. Use :0Git to
:G --paginate {args} |:edit| the temp file instead. A temp file is always |:edit| the temp file instead. A temp file is always
:G -p {args} used for commands like diff and log that typically used for commands like diff and log that typically
user a pager, and for any command that has the uses a pager, and for any command that has the
pager.<cmd> Git configuration option set. pager.<cmd> Git configuration option set.
:{range}Git! --paginate {args}
:{range}Git! -p {args} Run an arbitrary git command, and insert the output
after {range} in the current buffer.
*fugitive-summary* *fugitive-summary*
:Git With no arguments, bring up a summary window vaguely :Git With no arguments, bring up a summary window vaguely
:G akin to git-status. Press g? or see |fugitive-maps| akin to git-status. Press g? or see |fugitive-maps|
for usage. for usage.
*:Git_blame* *:Git_blame*
@@ -85,12 +99,12 @@ that are part of Git repositories).
:Git mergetool [args] Like |:Git_difftool|, but target merge conflicts. :Git mergetool [args] Like |:Git_difftool|, but target merge conflicts.
*:Ggrep* *:Gcgrep* *:Git_grep* *:Ggrep* *:Gcgrep* *:Git_grep*
:Ggrep[!] [args] |:grep|[!] with git-grep as 'grepprg'. :Ggrep[!] [args] An approximation of |:grep|[!] with git-grep as
:Git[!] grep [args] :Git[!] grep -O [args] 'grepprg'.
*:Glgrep* *:Glgrep*
:Glgrep[!] [args] |:lgrep|[!] with git-grep as 'grepprg'. :Glgrep[!] [args] :Ggrep but for |:lgrep|.
:0Git[!] grep [args] :0Git[!] grep -O [args]
*:Gclog* *:Gclog*
:Gclog[!] [args] Use git-log [args] to load the commit history into the :Gclog[!] [args] Use git-log [args] to load the commit history into the