mirror of
https://github.com/tpope/vim-fugitive.git
synced 2025-11-08 19:43:46 -05:00
Compare commits
1 Commits
v2.4
...
nested/tes
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f61beed747 |
2
.gitattributes
vendored
2
.gitattributes
vendored
@@ -1,2 +0,0 @@
|
|||||||
.git* export-ignore
|
|
||||||
*.markdown export-ignore
|
|
||||||
@@ -8,14 +8,8 @@ platform issues, and interactions with other plugins. I end up bisecting a
|
|||||||
lot more than other projects, and thus I'm especially meticulous here about
|
lot more than other projects, and thus I'm especially meticulous here about
|
||||||
maintaining a clean, readable, history. Squash and force push any requested
|
maintaining a clean, readable, history. Squash and force push any requested
|
||||||
changes to a pull request. And if your [commit message
|
changes to a pull request. And if your [commit message
|
||||||
sucks](https://commit.style), I'm not going to accept it. Period.
|
sucks](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
|
||||||
|
I'm not going to accept it. Period.
|
||||||
If your contribution involves adding a configuration option, you are going to
|
|
||||||
need a very compelling justification for it. Options add a maintenance
|
|
||||||
burden, support burden, and documentation bloat, and oftentimes can be
|
|
||||||
achieved much more simply with a custom map or autocommand. If your option
|
|
||||||
controls an underlying Git command, ask yourself why Git itself does not offer
|
|
||||||
such configuration.
|
|
||||||
|
|
||||||
Beyond that, don't be shy about asking before patching. What takes you hours
|
Beyond that, don't be shy about asking before patching. What takes you hours
|
||||||
might take me minutes simply because I have both domain knowledge and a
|
might take me minutes simply because I have both domain knowledge and a
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ changed, or `o` to open it in a split. When you're done, use `:Gedit`
|
|||||||
in the historic buffer to go back to the work tree version.
|
in the historic buffer to go back to the work tree version.
|
||||||
|
|
||||||
`:Gmove` does a `git mv` on a file and simultaneously renames the
|
`:Gmove` does a `git mv` on a file and simultaneously renames the
|
||||||
buffer. `:Gdelete` does a `git rm` on a file and simultaneously deletes
|
buffer. `:Gremove` does a `git rm` on a file and simultaneously deletes
|
||||||
the buffer.
|
the buffer.
|
||||||
|
|
||||||
Use `:Ggrep` to search the work tree (or any arbitrary commit) with
|
Use `:Ggrep` to search the work tree (or any arbitrary commit) with
|
||||||
@@ -35,17 +35,11 @@ and you never get any warnings about the file changing outside Vim.
|
|||||||
making it like `git add` when called from a work tree file and like
|
making it like `git add` when called from a work tree file and like
|
||||||
`git checkout` when called from the index or a blob in history.
|
`git checkout` when called from the index or a blob in history.
|
||||||
|
|
||||||
Use `:Gbrowse` to open the current file on the web front-end of your favorite
|
Use `:Gbrowse` to open the current file on GitHub, with optional line
|
||||||
hosting provider, with optional line range (try it in visual mode!). Built-in
|
range (try it in visual mode!). If your current repository isn't on
|
||||||
support is provided for `git instaweb`, and plugins are available for popular
|
GitHub, `git instaweb` will be spun up instead.
|
||||||
providers such as [GitHub][rhubarb.vim], [GitLab][fugitive-gitlab.vim], and
|
|
||||||
[Bitbucket][fubitive.vim].
|
|
||||||
|
|
||||||
[rhubarb.vim]: https://github.com/tpope/vim-rhubarb
|
Add `%{fugitive#statusline()}` to `'statusline'` to get an indicator
|
||||||
[fugitive-gitlab.vim]: https://github.com/shumphrey/fugitive-gitlab.vim
|
|
||||||
[fubitive.vim]: https://github.com/tommcdo/vim-fubitive
|
|
||||||
|
|
||||||
Add `%{FugitiveStatusline()}` to `'statusline'` to get an indicator
|
|
||||||
with the current branch in (surprise!) your statusline.
|
with the current branch in (surprise!) your statusline.
|
||||||
|
|
||||||
Last but not least, there's `:Git` for running any arbitrary command,
|
Last but not least, there's `:Git` for running any arbitrary command,
|
||||||
@@ -66,7 +60,7 @@ If you don't have a preferred installation method, one option is to install
|
|||||||
and paste:
|
and paste:
|
||||||
|
|
||||||
cd ~/.vim/bundle
|
cd ~/.vim/bundle
|
||||||
git clone https://github.com/tpope/vim-fugitive.git
|
git clone git://github.com/tpope/vim-fugitive.git
|
||||||
vim -u NONE -c "helptags vim-fugitive/doc" -c q
|
vim -u NONE -c "helptags vim-fugitive/doc" -c q
|
||||||
|
|
||||||
If your Vim version is below 7.2, I recommend also installing
|
If your Vim version is below 7.2, I recommend also installing
|
||||||
@@ -75,11 +69,24 @@ other Git niceties.
|
|||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
> Why don't any of the commands exist?
|
> I installed the plugin and started Vim. Why don't any of the commands
|
||||||
|
> exist?
|
||||||
|
|
||||||
Fugitive cares about the current file, not the current working directory.
|
Fugitive cares about the current file, not the current working
|
||||||
Edit a file from the repository. To avoid the blank window problem, favor
|
directory. Edit a file from the repository.
|
||||||
commands like `:split` and `:tabedit` over commands like `:new` and `:tabnew`.
|
|
||||||
|
> I opened a new tab. Why don't any of the commands exist?
|
||||||
|
|
||||||
|
Fugitive cares about the current file, not the current working
|
||||||
|
directory. Edit a file from the repository.
|
||||||
|
|
||||||
|
> Why is `:Gbrowse` not using the right browser?
|
||||||
|
|
||||||
|
`:Gbrowse` delegates to `git web--browse`, which is less than perfect
|
||||||
|
when it comes to finding the right browser. You can tell it the correct
|
||||||
|
browser to use with `git config --global web.browser ...`. On OS X, for
|
||||||
|
example, you might want to set this to `open`. See `git web--browse --help`
|
||||||
|
for details.
|
||||||
|
|
||||||
> Here's a patch that automatically opens the quickfix window after
|
> Here's a patch that automatically opens the quickfix window after
|
||||||
> `:Ggrep`.
|
> `:Ggrep`.
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -40,12 +40,10 @@ that are part of Git repositories).
|
|||||||
<CR> |:Gedit|
|
<CR> |:Gedit|
|
||||||
- |:Git| add
|
- |:Git| add
|
||||||
- |:Git| reset (staged files)
|
- |:Git| reset (staged files)
|
||||||
a Show alternative format
|
cA |:Gcommit| --amend --reuse-message=HEAD
|
||||||
ca |:Gcommit| --amend
|
ca |:Gcommit| --amend
|
||||||
cc |:Gcommit|
|
cc |:Gcommit|
|
||||||
ce |:Gcommit| --amend --no-edit
|
cva |:Gcommit| --amend --verbose
|
||||||
cw |:Gcommit| --amend --only
|
|
||||||
cva |:Gcommit| --verbose --amend
|
|
||||||
cvc |:Gcommit| --verbose
|
cvc |:Gcommit| --verbose
|
||||||
D |:Gdiff|
|
D |:Gdiff|
|
||||||
ds |:Gsdiff|
|
ds |:Gsdiff|
|
||||||
@@ -54,15 +52,11 @@ that are part of Git repositories).
|
|||||||
dv |:Gvdiff|
|
dv |:Gvdiff|
|
||||||
O |:Gtabedit|
|
O |:Gtabedit|
|
||||||
o |:Gsplit|
|
o |:Gsplit|
|
||||||
P |:Git| add --patch
|
p |:Git| add --patch
|
||||||
P |:Git| reset --patch (staged files)
|
p |:Git| reset --patch (staged files)
|
||||||
q close status
|
q close status
|
||||||
r reload status
|
r reload status
|
||||||
S |:Gvsplit|
|
S |:Gvsplit|
|
||||||
U |:Git| checkout
|
|
||||||
U |:Git| checkout HEAD (staged files)
|
|
||||||
U |:Git| clean (untracked files)
|
|
||||||
U |:Git| rm (unmerged files)
|
|
||||||
|
|
||||||
*fugitive-:Gcommit*
|
*fugitive-:Gcommit*
|
||||||
:Gcommit [args] A wrapper around git-commit. If there is nothing
|
:Gcommit [args] A wrapper around git-commit. If there is nothing
|
||||||
@@ -78,21 +72,17 @@ that are part of Git repositories).
|
|||||||
|
|
||||||
*fugitive-:Gmerge*
|
*fugitive-:Gmerge*
|
||||||
:Gmerge [args] Calls git-merge and loads errors and conflicted files
|
:Gmerge [args] Calls git-merge and loads errors and conflicted files
|
||||||
into the |quickfix| list. Opens a |:Gcommit| style
|
into the quickfix list. Opens a |:Gcommit| style
|
||||||
split window for the commit message if the merge
|
split window for the commit message if the merge
|
||||||
succeeds. If called during a merge conflict, the
|
succeeds. If called during a merge conflict, the
|
||||||
conflicted files from the current index are loaded
|
conflicted files from the current index are loaded
|
||||||
into the |quickfix| list.
|
into the quickfix list.
|
||||||
|
|
||||||
*fugitive-:Gpull*
|
*fugitive-:Gpull*
|
||||||
:Gpull [args] Like |:Gmerge|, but for git-pull.
|
:Gpull [args] Like |:Gmerge|, but for git-pull.
|
||||||
|
|
||||||
*fugitive-:Grebase*
|
|
||||||
:Grebase [args] Like |:Gmerge|, but for git-rebase. Interactive
|
|
||||||
rebase not suppported.
|
|
||||||
|
|
||||||
*fugitive-:Gpush*
|
*fugitive-:Gpush*
|
||||||
:Gpush [args] Invoke git-push, load the results into the |quickfix|
|
:Gpush [args] Invoke git-push, load the results into the quickfix
|
||||||
list, and invoke |:cwindow| to reveal any errors.
|
list, and invoke |:cwindow| to reveal any errors.
|
||||||
|:Dispatch| is used if available for asynchronous
|
|:Dispatch| is used if available for asynchronous
|
||||||
invocation.
|
invocation.
|
||||||
@@ -101,27 +91,27 @@ that are part of Git repositories).
|
|||||||
:Gfetch [args] Like |:Gpush|, but for git-fetch.
|
:Gfetch [args] Like |:Gpush|, but for git-fetch.
|
||||||
|
|
||||||
*fugitive-:Ggrep*
|
*fugitive-:Ggrep*
|
||||||
:Ggrep[!] [args] |:grep|[!] with git-grep as 'grepprg'.
|
:Ggrep [args] |:grep| with git-grep as 'grepprg'.
|
||||||
|
|
||||||
*fugitive-:Glgrep*
|
*fugitive-:Glgrep*
|
||||||
:Glgrep[!] [args] |:lgrep|[!] with git-grep as 'grepprg'.
|
:Glgrep [args] |:lgrep| with git-grep as 'grepprg'.
|
||||||
|
|
||||||
*fugitive-:Glog*
|
*fugitive-:Glog*
|
||||||
:Glog [args] Load all previous revisions of the current file into
|
:Glog [args] Load all previous revisions of the current file into
|
||||||
the |quickfix| list. Additional git-log arguments can
|
the quickfix list. Additional git-log arguments can
|
||||||
be given (for example, --reverse). If "--" appears as
|
be given (for example, --reverse). If "--" appears as
|
||||||
an argument, no file specific filtering is done, and
|
an argument, no file specific filtering is done, and
|
||||||
previous commits rather than previous file revisions
|
previous commits rather than previous file revisions
|
||||||
are loaded.
|
are loaded.
|
||||||
|
|
||||||
:{range}Glog [args] Use git-log -L to load previous revisions of the given
|
:{range}Glog [args] Use git-log -L to load previous revisions of the given
|
||||||
range of the current file into the |quickfix| list.
|
range of the current file into the quickfix list. The
|
||||||
The cursor is positioned on the first line of the
|
cursor is positioned on the first line of the first
|
||||||
first diff hunk for each commit.
|
diff hunk for each commit.
|
||||||
|
|
||||||
*fugitive-:Gllog*
|
*fugitive-:Gllog*
|
||||||
:Gllog [args] Like |:Glog|, but use the location list instead of the
|
:Gllog [args] Like |:Glog|, but use the location list instead of the
|
||||||
|quickfix| list.
|
quickfix list.
|
||||||
|
|
||||||
*fugitive-:Gedit* *fugitive-:Ge*
|
*fugitive-:Gedit* *fugitive-:Ge*
|
||||||
:Gedit [revision] |:edit| a |fugitive-revision|.
|
:Gedit [revision] |:edit| a |fugitive-revision|.
|
||||||
@@ -187,9 +177,7 @@ that are part of Git repositories).
|
|||||||
to the right or bottom, depending on 'diffopt' and
|
to the right or bottom, depending on 'diffopt' and
|
||||||
the width of the window relative to 'textwidth'. Use
|
the width of the window relative to 'textwidth'. Use
|
||||||
|do| and |dp| and write to the index file to simulate
|
|do| and |dp| and write to the index file to simulate
|
||||||
"git add --patch". For the three-way diff, there is
|
"git add --patch".
|
||||||
also d2o and d3o pulling the hunk to the middle from
|
|
||||||
the left or the right window, respectively.
|
|
||||||
|
|
||||||
*fugitive-:Gsdiff*
|
*fugitive-:Gsdiff*
|
||||||
:Gsdiff [revision] Like |:Gdiff|, but always split horizontally.
|
:Gsdiff [revision] Like |:Gdiff|, but always split horizontally.
|
||||||
@@ -201,23 +189,14 @@ that are part of Git repositories).
|
|||||||
:Gmove {destination} Wrapper around git-mv that renames the buffer
|
:Gmove {destination} Wrapper around git-mv that renames the buffer
|
||||||
afterward. The destination is relative to the current
|
afterward. The destination is relative to the current
|
||||||
directory except when started with a /, in which case
|
directory except when started with a /, in which case
|
||||||
it is relative to the work tree. (This is a holdover
|
it is relative to the work tree. Add a ! to pass -f.
|
||||||
from before |:Grename| and will be removed.) Add a !
|
|
||||||
to pass -f.
|
|
||||||
|
|
||||||
*fugitive-:Grename*
|
*fugitive-:Gremove*
|
||||||
:Grename {destination} Like |:Gmove| but operates relative to the parent
|
:Gremove Wrapper around git-rm that deletes the buffer
|
||||||
directory of the current file.
|
|
||||||
|
|
||||||
*fugitive-:Gdelete*
|
|
||||||
:Gdelete Wrapper around git-rm that deletes the buffer
|
|
||||||
afterward. When invoked in an index file, --cached is
|
afterward. When invoked in an index file, --cached is
|
||||||
passed. Add a ! to pass -f and forcefully discard the
|
passed. Add a ! to pass -f and forcefully discard the
|
||||||
buffer.
|
buffer.
|
||||||
|
|
||||||
*fugitive-:Gremove*
|
|
||||||
:Gremove Like :Gdelete, but keep the (now empty) buffer around.
|
|
||||||
|
|
||||||
*fugitive-:Gblame*
|
*fugitive-:Gblame*
|
||||||
:Gblame [flags] Run git-blame on the file and open the results in a
|
:Gblame [flags] Run git-blame on the file and open the results in a
|
||||||
scroll bound vertical split. You can give any of
|
scroll bound vertical split. You can give any of
|
||||||
@@ -242,20 +221,20 @@ that are part of Git repositories).
|
|||||||
|
|
||||||
*fugitive-:Gbrowse*
|
*fugitive-:Gbrowse*
|
||||||
:Gbrowse Open the current file, blob, tree, commit, or tag
|
:Gbrowse Open the current file, blob, tree, commit, or tag
|
||||||
in your browser at the upstream hosting provider.
|
in your browser at the upstream hosting provider
|
||||||
If a range is given, it is appropriately appended to
|
indicated by the "origin" remote. If a range is
|
||||||
the URL as an anchor.
|
given, it is appropriately appended to the URL as an
|
||||||
|
anchor.
|
||||||
|
|
||||||
Upstream providers can be added by installing an
|
Upstream providers can be added by installing an
|
||||||
appropriate Vim plugin. For example, GitHub can be
|
appropriate Vim plugin. For example, GitHub can be
|
||||||
supported by installing rhubarb.vim, available at
|
supported by installing rhubarb.vim, available at
|
||||||
<https://github.com/tpope/vim-rhubarb>.
|
<https://github.com/tpope/vim-rhubarb>. (Native
|
||||||
|
support for GitHub is currently included, but that is
|
||||||
|
slated to be removed.)
|
||||||
|
|
||||||
The hosting provider is determined by looking at the
|
If no upstream support is available, a local instance
|
||||||
remote for the current or specified branch and falls
|
of git-instaweb will be started and used instead.
|
||||||
back to "origin". In the special case of a "."
|
|
||||||
remote, a local instance of git-instaweb will be
|
|
||||||
started and used.
|
|
||||||
|
|
||||||
:Gbrowse {revision} Like :Gbrowse, but for a given |fugitive-revision|. A
|
:Gbrowse {revision} Like :Gbrowse, but for a given |fugitive-revision|. A
|
||||||
useful value here is -, which ties the URL to the
|
useful value here is -, which ties the URL to the
|
||||||
@@ -330,13 +309,13 @@ and the work tree file for everything else. Example revisions follow.
|
|||||||
|
|
||||||
Revision Meaning ~
|
Revision Meaning ~
|
||||||
HEAD .git/HEAD
|
HEAD .git/HEAD
|
||||||
refs/heads/x .git/refs/heads/x
|
master .git/refs/heads/master
|
||||||
@ The commit referenced by @ aka HEAD
|
HEAD^{} The commit referenced by HEAD
|
||||||
master^ The parent of the commit referenced by master
|
HEAD^ The parent of the commit referenced by HEAD
|
||||||
master: The tree referenced by master
|
HEAD: The tree referenced by HEAD
|
||||||
/master The file named master in the work tree
|
/HEAD The file named HEAD in the work tree
|
||||||
Makefile The file named Makefile in the work tree
|
Makefile The file named Makefile in the work tree
|
||||||
@^:Makefile The file named Makefile in the parent of HEAD
|
HEAD^:Makefile The file named Makefile in the parent of HEAD
|
||||||
:Makefile The file named Makefile in the index (writable)
|
:Makefile The file named Makefile in the index (writable)
|
||||||
- The current file in HEAD
|
- The current file in HEAD
|
||||||
^ The current file in the previous commit
|
^ The current file in the previous commit
|
||||||
@@ -350,16 +329,16 @@ Makefile The file named Makefile in the work tree
|
|||||||
|
|
||||||
STATUSLINE *fugitive-statusline*
|
STATUSLINE *fugitive-statusline*
|
||||||
|
|
||||||
*FugitiveStatusline()* *fugitive#statusline()*
|
*fugitive#statusline()*
|
||||||
Add %{FugitiveStatusline()} to your statusline to get an indicator including
|
Add %{fugitive#statusline()} to your statusline to get an indicator including
|
||||||
the current branch and the currently edited file's commit. If you don't have
|
the current branch and the currently edited file's commit. If you don't have
|
||||||
a statusline, this one matches the default when 'ruler' is set:
|
a statusline, this one matches the default when 'ruler' is set:
|
||||||
>
|
>
|
||||||
set statusline=%<%f\ %h%m%r%{FugitiveStatusline()}%=%-14.(%l,%c%V%)\ %P
|
set statusline=%<%f\ %h%m%r%{fugitive#statusline()}%=%-14.(%l,%c%V%)\ %P
|
||||||
<
|
<
|
||||||
*FugitiveHead(...)* *fugitive#head(...)*
|
*fugitive#head(...)*
|
||||||
Use FugitiveHead() to return the name of the current branch. If the current
|
Use fugitive#head() to return the name of the current branch. If the current
|
||||||
HEAD is detached, FugitiveHead() will return the empty string, unless the
|
HEAD is detached, fugitive#head() will return the empty string, unless the
|
||||||
optional argument is given, in which case the hash of the current commit will
|
optional argument is given, in which case the hash of the current commit will
|
||||||
be truncated to the given number of characters.
|
be truncated to the given number of characters.
|
||||||
|
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
autocmd BufReadPost *.fugitiveblame setfiletype fugitiveblame
|
|
||||||
3116
plugin/fugitive.vim
3116
plugin/fugitive.vim
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user