fish-shell/doc_src/cmds/fish_vcs_prompt.rst
Fabian Homborg 0f34459fce Disable svn prompt by default
This is apparently quite slow on large svn repos (like 40 seconds
slow), and we don't have a good thing to display other than the full
file information.

So we'll have to disable it for now.

Fixes #6681.

[ci skip]
2020-03-01 17:04:02 +01:00

41 lines
1.2 KiB
ReStructuredText

.. _cmd-fish_vcs_prompt:
fish_vcs_prompt - output version control system information for use in a prompt
===============================================================================
Synopsis
--------
::
function fish_prompt
echo -n (pwd)(fish_vcs_prompt) '$ '
end
Description
-----------
The ``fish_vcs_prompt`` function displays information about the current version control system (VCS) repository, if any.
It calls out to VCS-specific functions. The currently supported systems are:
- :ref:`fish_git_prompt <cmd-fish_git_prompt>`
- :ref:`fish_hg_prompt <cmd-fish_hg_prompt>`
- :ref:`fish_svn_prompt <cmd-fish_svn_prompt>`
If a VCS isn't installed, the respective function does nothing.
The svn prompt is disabled by default because it's slow on large svn repositories. To enable it, modify fish_vcs_prompt to uncomment it. See :ref:`funced <cmd-funced>`.
For more information, see the documentation for each of the functions above.
Example
-------
A simple prompt that displays all known VCS info::
function fish_prompt
...
set -g __fish_git_prompt_showupstream auto
printf '%s %s$' $PWD (fish_vcs_prompt)
end