mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-12-01 15:14:26 +08:00
38b24c2325
This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
46 lines
1.2 KiB
ReStructuredText
46 lines
1.2 KiB
ReStructuredText
.. _cmd-fish_vcs_prompt:
|
|
|
|
fish_vcs_prompt - output version control system information for use in a prompt
|
|
===============================================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. 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:
|
|
|
|
- :doc:`fish_git_prompt <fish_git_prompt>`
|
|
- :doc:`fish_hg_prompt <fish_hg_prompt>`
|
|
- :doc:`fish_svn_prompt <fish_svn_prompt>`
|
|
|
|
If a VCS isn't installed, the respective function does nothing.
|
|
|
|
The Subversion prompt is disabled by default, because it's slow on large repositories. To enable it, modify ``fish_vcs_prompt`` to uncomment it. See :doc:`funced <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
|