fish-shell/doc_src/cmds/fish_vcs_prompt.rst

.. _cmd-fish_vcs_prompt:

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

Synopsis
--------

``fish_vcs_prompt``
::

     function fish_prompt
          printf '%s' $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
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 09:05:09 +00:00			`.. _cmd-fish_vcs_prompt:`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`fish_vcs_prompt - output version control system information for use in a prompt`
			`===============================================================================`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`Synopsis`
			`--------`

doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-17 23:16:47 +00:00			``fish_vcs_prompt``
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`::`

			`function fish_prompt`
Synopses examples for vcs services now function as intended 2020-10-02 21:36:29 +00:00			`printf '%s' $PWD (fish_vcs_prompt) ' $ '`
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 09:59:04 +00:00			`end`

Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00			`Description`
			`-----------`

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00: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 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`It calls out to VCS-specific functions. The currently supported systems are:`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00: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 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`If a VCS isn't installed, the respective function does nothing.`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
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 16:03:15 +00:00			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>`.

docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`For more information, see the documentation for each of the functions above.`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: Fix remaining "\subsection" markup See #5696. [ci skip] 2019-03-24 18:44:45 +00:00			`Example`
			`-------`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip] 2019-04-11 15:51:00 +00:00			`A simple prompt that displays all known VCS info::`
Add the vcs prompts to sphinx docs 2019-02-25 00:20:25 +00:00
			`function fish_prompt`
			`...`
			`set -g __fish_git_prompt_showupstream auto`
			`printf '%s %s$' $PWD (fish_vcs_prompt)`
			`end`