mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-06-01 21:21:15 -03:00
We no longer have two doc systems, move sphinx_doc_src back to doc_src
This commit is contained in:
39
doc_src/cmds/fish_vcs_prompt.rst
Normal file
39
doc_src/cmds/fish_vcs_prompt.rst
Normal file
@@ -0,0 +1,39 @@
|
||||
.. _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.
|
||||
|
||||
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
|
||||
Reference in New Issue
Block a user