mirror of
https://github.com/tpope/vim-fugitive.git
synced 2025-11-09 20:13:46 -05:00
Document autocommands
This commit is contained in:
@@ -601,6 +601,37 @@ 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%{FugitiveStatusline()}%=%-14.(%l,%c%V%)\ %P
|
||||||
<
|
<
|
||||||
|
AUTOCOMMANDS *fugitive-autocommands*
|
||||||
|
|
||||||
|
A handful of |User| |autocommands| are provided to allow extending and
|
||||||
|
overriding Fugitive behaviors. Example usage:
|
||||||
|
>
|
||||||
|
autocmd User FugitiveBlob call s:BlobOverrides()
|
||||||
|
<
|
||||||
|
*User_FugitiveIndex*
|
||||||
|
FugitiveIndex After loading the |fugitive-summary| buffer.
|
||||||
|
|
||||||
|
*User_FugitiveTag*
|
||||||
|
FugitiveTag After loading a tag object.
|
||||||
|
|
||||||
|
*User_FugitiveCommit*
|
||||||
|
FugitiveCommit After loading a commit object.
|
||||||
|
|
||||||
|
*User_FugitiveTree*
|
||||||
|
FugitiveTree After loading a tree (directory) object.
|
||||||
|
|
||||||
|
*User_FugitiveBlob*
|
||||||
|
FugitiveBlob After loading a blob (file) object. This includes
|
||||||
|
both committed blobs which are read only, and staged
|
||||||
|
blobs which can be edited and written. Check
|
||||||
|
&modifiable to distinguish between the two.
|
||||||
|
|
||||||
|
*User_FugitiveChanged*
|
||||||
|
FugitiveChanged After any event which can potentially change the
|
||||||
|
repository, for example, any invocation of |:Git|.
|
||||||
|
Originally intended for expiring caches, but can have
|
||||||
|
other uses.
|
||||||
|
|
||||||
API *fugitive-api*
|
API *fugitive-api*
|
||||||
|
|
||||||
Officially supported functions are documented inline in plugin/fugitive.vim.
|
Officially supported functions are documented inline in plugin/fugitive.vim.
|
||||||
@@ -636,6 +667,14 @@ version.
|
|||||||
*:Gtabsplit!* Superseded by :tab Git --paginate.
|
*:Gtabsplit!* Superseded by :tab Git --paginate.
|
||||||
*:Gpedit!* Superseded by :Git! --paginate.
|
*:Gpedit!* Superseded by :Git! --paginate.
|
||||||
|
|
||||||
|
*User_Fugitive*
|
||||||
|
Fugitive used to support `:autocmd User Fugitive` to run an autocommand after
|
||||||
|
loading any buffer belonging to a Git repository, but this is being phased
|
||||||
|
out. Instead, one can leverage regular autocommand events like |BufNewFile|
|
||||||
|
and |BufReadPost|, and check !empty(FugitiveGitDir()) to confirm Fugitive has
|
||||||
|
found a repository. See also |fugitive-autocommands| for other, more
|
||||||
|
selective events.
|
||||||
|
|
||||||
ABOUT *fugitive-about*
|
ABOUT *fugitive-about*
|
||||||
|
|
||||||
Grab the latest version or report a bug on GitHub:
|
Grab the latest version or report a bug on GitHub:
|
||||||
|
|||||||
@@ -99,9 +99,11 @@ function! FugitiveParse(...) abort
|
|||||||
endfunction
|
endfunction
|
||||||
|
|
||||||
" FugitiveResult() returns an object encapsulating the result of the most
|
" FugitiveResult() returns an object encapsulating the result of the most
|
||||||
" recend :Git command. Will be empty if no result is available. Pass in the
|
" recent :Git command. Will be empty if no result is available. During a
|
||||||
" name of a temp buffer to get the result object for that command instead.
|
" User FugitiveChanged event, this is guaranteed to correspond to the :Git
|
||||||
" Contains the following keys:
|
" command that triggered the event, or be empty if :Git was not the trigger.
|
||||||
|
" Pass in the name of a temp buffer to get the result object for that command
|
||||||
|
" instead. Contains the following keys:
|
||||||
"
|
"
|
||||||
" * "args": List of command arguments, starting with the subcommand. Will be
|
" * "args": List of command arguments, starting with the subcommand. Will be
|
||||||
" empty for usages like :Git --help.
|
" empty for usages like :Git --help.
|
||||||
|
|||||||
Reference in New Issue
Block a user