Quarantine deprecated commands in documentation

This commit is contained in:
Tim Pope
2020-02-18 14:09:24 -05:00
parent 2401f1a7da
commit d10dc9ea93
2 changed files with 69 additions and 59 deletions

View File

@@ -5846,11 +5846,11 @@ function! fugitive#MapJumps(...) abort
nnoremap <buffer> <silent> cRa :<C-U>Gcommit --reset-author --amend<CR> nnoremap <buffer> <silent> cRa :<C-U>Gcommit --reset-author --amend<CR>
nnoremap <buffer> <silent> cRe :<C-U>Gcommit --reset-author --amend --no-edit<CR> nnoremap <buffer> <silent> cRe :<C-U>Gcommit --reset-author --amend --no-edit<CR>
nnoremap <buffer> <silent> cRw :<C-U>Gcommit --reset-author --amend --only<CR> nnoremap <buffer> <silent> cRw :<C-U>Gcommit --reset-author --amend --only<CR>
nnoremap <buffer> cf :<C-U>Gcommit --fixup=<C-R>=<SID>SquashArgument()<CR> nnoremap <buffer> cf :<C-U>Git commit --fixup=<C-R>=<SID>SquashArgument()<CR>
nnoremap <buffer> cF :<C-U><Bar>Grebase --autosquash<C-R>=<SID>RebaseArgument()<CR><Home>Gcommit --fixup=<C-R>=<SID>SquashArgument()<CR> nnoremap <buffer> cF :<C-U><Bar>Git rebase --autosquash<C-R>=<SID>RebaseArgument()<CR><Home>Git commit --fixup=<C-R>=<SID>SquashArgument()<CR>
nnoremap <buffer> cs :<C-U>Gcommit --no-edit --squash=<C-R>=<SID>SquashArgument()<CR> nnoremap <buffer> cs :<C-U>Git commit --no-edit --squash=<C-R>=<SID>SquashArgument()<CR>
nnoremap <buffer> cS :<C-U><Bar>Grebase --autosquash<C-R>=<SID>RebaseArgument()<CR><Home>Gcommit --no-edit --squash=<C-R>=<SID>SquashArgument()<CR> nnoremap <buffer> cS :<C-U><Bar>Git rebase --autosquash<C-R>=<SID>RebaseArgument()<CR><Home>Git commit --no-edit --squash=<C-R>=<SID>SquashArgument()<CR>
nnoremap <buffer> cA :<C-U>Gcommit --edit --squash=<C-R>=<SID>SquashArgument()<CR> nnoremap <buffer> cA :<C-U>Git commit --edit --squash=<C-R>=<SID>SquashArgument()<CR>
nnoremap <buffer> <silent> c? :<C-U>help fugitive_c<CR> nnoremap <buffer> <silent> c? :<C-U>help fugitive_c<CR>
nnoremap <buffer> cr<Space> :Git revert<Space> nnoremap <buffer> cr<Space> :Git revert<Space>

View File

@@ -28,16 +28,16 @@ that are part of Git repositories).
:Git! {args} Run an arbitrary git command, capture output to a temp :Git! {args} Run an arbitrary git command, capture output to a temp
:Git --paginate {args} file, and |:split| that temp file. Use :0Git to :Git --paginate {args} file, and |:split| that temp file. Use :0Git to
:Git -p {args} |:edit| the temp file instead. A temp file is always :Git -p {args} |:edit| the temp file instead. A temp file is always
used for diff and log commands. :G ... used for diff and log commands.
*:Gstatus* *fugitive-summary*
:Git Bring up a summary window vaguely akin to git-status. :Git With no arguments, bring up a summary window vaguely
:G Press g? or see |fugitive-maps| for usage. :G akin to git-status. Press g? or see |fugitive-maps|
:Gstatus for usage.
*:Git-blame* *:Gblame* *:Git-blame*
:Git blame [flags] Run git-blame [flags] on the current file and open the :Git blame [flags] Run git-blame [flags] on the current file and open the
:Gblame [flags] results in a scroll-bound vertical split. The results in a scroll-bound vertical split. The
following maps, which work on the cursor line commit following maps, which work on the cursor line commit
where sensible, are provided: where sensible, are provided:
@@ -56,9 +56,9 @@ that are part of Git repositories).
~ reblame at [count]th first grandparent ~ reblame at [count]th first grandparent
P reblame at [count]th parent (like HEAD^[count]) P reblame at [count]th parent (like HEAD^[count])
:[range]Gblame [flags] If a range is given, just that part of the file will :[range]Git blame [...] If a range is given, just that part of the file will
:Gblame [flags] {file} be blamed, and a horizontal split without :Git blame [...] {file} be blamed, and a horizontal split without
:Git blame ... scrollbinding is used. You can also give an arbitrary scrollbinding is used. You can also give an arbitrary
filename. filename.
*:Ggrep* *:Gcgrep* *:Git-grep* *:Ggrep* *:Gcgrep* *:Git-grep*
@@ -83,36 +83,18 @@ that are part of Git repositories).
*:Git-mergetool* *:Git-mergetool*
:Git mergetool [args] Like |:Git-difftool|, but target merge conflicts. :Git mergetool [args] Like |:Git-difftool|, but target merge conflicts.
*:Git-push* *:Gpush* *:Git-push*
:Git push [args] Invoke git-push, load the results into the |quickfix| :Git push [args] Invoke git-push, load the results into the |quickfix|
:Gpush [args] 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.
*:Git-fetch* *:Gfetch* *:Git-fetch*
:Git fetch [args] Like |:Gpush|, but for git-fetch. :Git fetch [args] Like |:Git-push|, but for git-fetch.
:Gfetch [args]
*:Git-merge* *:Gmerge* *:Gclog*
:Gmerge [args] Deprecated alias for |:Git| merge. Use |:Git-mergetool|
to get the old behavior of loading merge conflicts
into the quickfix list.
*:Git-pull* *:Gpull*
:Gpull [args] Deprecated alias for |:Git| pull.
*:Git-rebase* *:Grebase*
:Grebase [args] Deprecated alias for |:Git| rebase.
*:Git-commit* *:Gcommit*
:Gcommit [args] Deprecated alias for |:Git| commit.
*:Git-revert* *:Grevert*
:Grevert [args] Deprecated alias for |:Git| revert.
*:Gclog* *:Glog*
: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
:Glog[!] [args] |quickfix| list. Jumps to the first commit unless [!] |quickfix| list. Jumps to the first commit unless [!]
is given. is given.
:{range}Gclog[!] [args] Use git-log -L to load previous revisions of the given :{range}Gclog[!] [args] Use git-log -L to load previous revisions of the given
@@ -210,28 +192,28 @@ that are part of Git repositories).
*:Gvdiffsplit* *:Gvdiffsplit*
:Gvdiffsplit [object] Like |:Gdiffsplit|, but always split vertically. :Gvdiffsplit [object] Like |:Gdiffsplit|, but always split vertically.
*:Ghdiffsplit* *:Gsdiff* *:Ghdiffsplit*
:Ghdiffsplit [object] Like |:Gdiffsplit|, but always split horizontally. :Ghdiffsplit [object] Like |:Gdiffsplit|, but always split horizontally.
*:Gmove* *:GMove*
:Gmove {destination} Wrapper around git-mv that renames the buffer :GMove {destination} Wrapper around git-mv that renames the buffer
afterward. Add a ! to pass -f. afterward. Add a ! to pass -f.
*:Grename* *:GRename*
:Grename {destination} Like |:Gmove| but operates relative to the parent :GRename {destination} Like |:Gmove| but operates relative to the parent
directory of the current file. directory of the current file.
*:Gdelete* *:GDelete*
:Gdelete Wrapper around git-rm that deletes the buffer :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.
*:Gremove* *:GRemove*
:Gremove Like :Gdelete, but keep the (now empty) buffer around. :GRemove Like :Gdelete, but keep the (now empty) buffer around.
*:Gbrowse* *: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 If a range is given, it is appropriately appended to
the URL as an anchor. the URL as an anchor.
@@ -241,27 +223,27 @@ that are part of Git repositories).
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>.
:Gbrowse {object} Like :Gbrowse, but for a given |fugitive-object|. :GBrowse {object} Like :Gbrowse, but for a given |fugitive-object|.
:Gbrowse [...]@{remote} Force using the given remote rather than the remote :GBrowse [...]@{remote} Force using the given remote rather than the remote
for the current branch. The remote is used to for the current branch. The remote is used to
determine which upstream repository to link to. determine which upstream repository to link to.
:{range}Gbrowse [args] Appends an anchor to the URL that emphasizes the :{range}GBrowse [args] Appends an anchor to the URL that emphasizes the
selected lines. This also forces the URL to include a selected lines. This also forces the URL to include a
commit rather than a branch name so it remains valid commit rather than a branch name so it remains valid
if the file changes. You can give a range of "0" to if the file changes. You can give a range of "0" to
force this behavior without including an anchor. force this behavior without including an anchor.
:[range]Gbrowse! [args] Like :Gbrowse, but put the URL on the clipboard rather :[range]GBrowse! [args] Like :Gbrowse, but put the URL on the clipboard rather
than opening it. than opening it.
MAPS *fugitive-maps* MAPS *fugitive-maps*
These maps are available in both the |:Gstatus| buffer and Fugitive object These maps are available in both the |fugitive-summary| buffer and Fugitive
buffers, although not all maps make sense in all buffers. Mappings that object buffers, although not all maps make sense in all buffers. Mappings
operate on the file or hunk under the cursor are generally available in visual that operate on the file or hunk under the cursor are generally available in
mode to operate on multiple files or partial hunks. visual mode to operate on multiple files or partial hunks.
*fugitive-staging-maps* *fugitive-staging-maps*
Staging/unstaging maps ~ Staging/unstaging maps ~
@@ -611,7 +593,7 @@ Makefile The file named Makefile in the work tree
!:Makefile The file named Makefile in the commit owning the current file !:Makefile The file named Makefile in the commit owning the current file
!3^2 The second parent of the commit owning buffer #3 !3^2 The second parent of the commit owning buffer #3
.git/config The repo config file .git/config The repo config file
: Same as |:Gstatus| : The |fugitive-summary| buffer.
STATUSLINE *fugitive-statusline* STATUSLINE *fugitive-statusline*
@@ -628,6 +610,34 @@ HEAD is detached, FugitiveHead() 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.
DEPRECATIONS *fugitive-deprecated*
The following commands are softly deprecated in favor of replacements that
adhere to a new naming scheme. They will eventually be removed, but probably
not in the near future.
Remember that |:Git| can be shortened to |:G|, so replacements using it are
just one space character longer than the legacy version.
*:Gremove* Superseded by |:GRemove|.
*:Gdelete* Superseded by |:GDelete|.
*:Gmove* Superseded by |:GMove|.
*:Grename* Superseded by |:GRename|.
*:Gbrowse* Superseded by |:GBrowse|.
*:Gcommit* Superseded by |:Git| commit.
*:Gdiff* Superseded by |:Gdiffsplit|
*:Gsdiff* Superseded by |:Ghdiffsplit|
*:Gvdiff* Superseded by |:Gvdiffsplit| or |:vert| |:Gdiffsplit|.
*:Gblame* Superseded by |:Git-blame|.
*:Gmerge* Superseded by |:Git| merge and |:Git-mergetool|.
*:Gpull* Superseded by |:Git| pull.
*:Grebase* Superseded by |:Git| rebase.
*:Grevert* Superseded by |:Git| revert.
*:Gpush* Superseded by |:Git-push|.
*:Gfetch* Superseded by |:Git-fetch|.
*:Glog* Superseded by |:Gclog|.
*:Gstatus* Superseded by |:Git| (with no arguments).
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: