mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-29 06:13:20 +00:00
Document vcs prompt
This commit is contained in:
parent
9c82979459
commit
f7c981af63
1 changed files with 28 additions and 0 deletions
28
doc_src/fish_vcs_prompt.txt
Normal file
28
doc_src/fish_vcs_prompt.txt
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
\section fish_vcs_prompt fish_vcs_prompt - output vcs information for use in a prompt
|
||||||
|
|
||||||
|
\subsection fish_vcs_prompt-description Description
|
||||||
|
|
||||||
|
The fish_vcs_prompt function can be used to display information about the current vcs repository, if any.
|
||||||
|
|
||||||
|
It calls out to vcs-specific functions. The currently supported ones are:
|
||||||
|
|
||||||
|
- fish_git_prompt
|
||||||
|
- fish_hg_prompt
|
||||||
|
- fish_svn_prompt
|
||||||
|
|
||||||
|
If a vcs isn't installed, the respective function does nothing.
|
||||||
|
|
||||||
|
For more information, see their documentation.
|
||||||
|
|
||||||
|
\subsection fish_vcs_prompt-example Example
|
||||||
|
|
||||||
|
A simple prompt that displays vcs info:
|
||||||
|
|
||||||
|
\fish
|
||||||
|
function fish_prompt
|
||||||
|
...
|
||||||
|
set -g __fish_git_prompt_showupstream auto
|
||||||
|
printf '%s %s$' $PWD (fish_vcs_prompt)
|
||||||
|
end
|
||||||
|
\endfish
|
||||||
|
|
Loading…
Reference in a new issue