fish-shell/sphinx_doc_src/cmds/fish_vcs_prompt.rst

.. _cmd-fish_vcs_prompt:

fish_vcs_prompt - output version control system information for use in a prompt
===============================================================================

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
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 17:05:09 +08:00			`.. _cmd-fish_vcs_prompt:`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			`fish_vcs_prompt - output version control system information for use in a prompt`
			`===============================================================================`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
			`Description`
			`-----------`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			The ``fish_vcs_prompt`` function displays information about the current version control system (VCS) repository, if any.
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			`It calls out to VCS-specific functions. The currently supported systems are:`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			- :ref:`fish_git_prompt <cmd-fish_git_prompt>`
			- :ref:`fish_hg_prompt <cmd-fish_hg_prompt>`
			- :ref:`fish_svn_prompt <cmd-fish_svn_prompt>`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			`If a VCS isn't installed, the respective function does nothing.`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			`For more information, see the documentation for each of the functions above.`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
docs: Fix remaining "\subsection" markup See #5696. [ci skip] 2019-03-25 02:44:45 +08:00			`Example`
			`-------`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 23:51:00 +08:00			`A simple prompt that displays all known VCS info::`
Add the vcs prompts to sphinx docs 2019-02-25 08:20:25 +08:00
			`function fish_prompt`
			`...`
			`set -g __fish_git_prompt_showupstream auto`
			`printf '%s %s$' $PWD (fish_vcs_prompt)`
			`end`