h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-02 22:21:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: update the VCS prompt function documentation

Browse Source 
Edited for clarity and formatting.

[ci skip]
This commit is contained in:
David Adam
2019-04-11 23:51:00 +08:00
parent c50eb7c85f
commit 87518a524f
4 changed files with 111 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
sphinx_doc_src/cmds/fish_vcs_prompt.rst
View File

@@ -1,27 +1,27 @@
.. _cmd-fish_vcs_prompt:
fish_vcs_prompt - output vcs information for use in a prompt
============================================================
fish_vcs_prompt - output version control system information for use in a prompt
===============================================================================
Description
-----------
The fish_vcs_prompt function can be used to display information about the current vcs repository, if any.
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 ones are:
It calls out to VCS-specific functions. The currently supported systems are:
- fish_git_prompt
- fish_hg_prompt
- fish_svn_prompt
- :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.
If a VCS isn't installed, the respective function does nothing.
For more information, see their documentation.
For more information, see the documentation for each of the functions above.
Example
-------
A simple prompt that displays vcs info::
A simple prompt that displays all known VCS info::
function fish_prompt
...