github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-27 11:43:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
cb79d8fa97
fish-shell/sphinx_doc_src/cmds/fish_git_prompt.rst

126 lines
5.6 KiB
ReStructuredText
Raw Normal View History

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_git_prompt:
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
fish_git_prompt - output git information for use in a 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 17:59:04 +08:00
Synopsis
--------
::
function fish_prompt
echo -n (pwd)(fish_git_prompt) '$ '
end
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_git_prompt`` function displays information about the current git 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
`Git <https://git-scm.com>`_ must be installed.
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
There are numerous customization options, which can be controlled with git options or fish variables. git options, where available, take precedence over the fish variable with the same function. git options can be set on a per-repository or global basis. git options can be set with the `git config` command, while fish variables can be set as usual with the :ref:`set <cmd-set>` command.
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
- ``$__fish_git_prompt_show_informative_status`` or the git option ``bash.showInformativeStatus`` can be set to enable the "informative" display, which will show a large amount of information - the number of untracked files, dirty files, unpushed/unpulled commits, and more. In large repositories, this can take a lot of time, so it you may wish to disable it in these repositories with ``git config --local bash.showInformativeStatus false``.
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
- ``$__fish_git_prompt_showdirtystate`` or the git option ``bash.showDirtyState`` can be set to show if the repository is "dirty", i.e. has uncommitted changes.
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
- ``$__fish_git_prompt_showuntrackedfiles`` or the git option ``bash.showUntrackedFiles`` can be set to show if the repository has untracked files (that aren't ignored).
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
docs/fish_git_prompt: showupstream is a proper list "space-delimited" sounds like you'd set it like `set __fish_git_prompt_showupstream "auto verbose"`. This will not work. It's a real actual proper list, which aren't space-delimited. [ci skip]
2019-08-24 01:34:33 +08:00
- ``$__fish_git_prompt_showupstream`` can be set to a list of values to determine how changes between HEAD and upstream are shown:
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
document auto option for __fish_git_prompt_showupstream
2019-08-20 09:56:23 +08:00
``auto``
summarize the difference between HEAD and its upstream
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
``verbose``
show number of commits ahead/behind (+/-) upstream
``name``
if verbose, then also show the upstream abbrev name
``informative``
similar to verbose, but shows nothing when equal - this is the default if informative status is enabled.
``git``
always compare HEAD to @{upstream}
``svn``
always compare HEAD to your SVN upstream
``none``
disables (useful with informative status)
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_showstashstate`` can be set to display the state of the stash.
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_shorten_branch_len`` can be set to the number of characters that the branch name will be shortened to.
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
specify that __fish_git_prompt_describe_style only takes one argument
2019-08-20 10:03:22 +08:00
- ``$__fish_git_prompt_describe_style`` can be set to one of the following styles to describe the current HEAD:
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
``contains``
relative to newer annotated tag, such as ``(v1.6.3.2~35)``
``branch``
relative to newer tag or branch, such as ``(master~4)``
``describe``
relative to older annotated tag, such as ``(v1.6.3.1-13-gdd42c2f)``
``default``
exactly matching tag
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
- ``$__fish_git_prompt_showcolorhints`` can be set to enable coloring for the branch name and status symbols.
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
fish_git_prompt: Add a way to use the informative chars $__fish_git_prompt_use_informative_chars will use the informative chars without requiring informative mode (which is really frickin' slow!). See #5726. [ci skip]
2019-06-25 21:06:26 +08:00
A number of variables set characters and color used as indicators. Many of these have a different default if used with informative status enabled, or ``$__fish_git_prompt_use_informative_chars`` set. The usual default is given first, then the informative default (if it is different). If no default for the colors is given, they default to ``$__fish_git_prompt_color``.
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
docs: Fix some sphinx errors See #5696. [ci skip]
2019-03-30 03:55:28 +08:00
- ``$__fish_git_prompt_char_stateseparator`` (' ', `|`)
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_color`` ('')
- ``$__fish_git_prompt_color_prefix``
- ``$__fish_git_prompt_color_suffix``
- ``$__fish_git_prompt_color_bare``
- ``$__fish_git_prompt_color_merging``
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
Some variables are only used in some modes, like when informative status is enabled:
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_char_cleanstate`` (✔)
- ``$__fish_git_prompt_color_cleanstate``
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
Variables used with ``showdirtystate``:
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
docs: Fix some sphinx errors See #5696. [ci skip]
2019-03-30 03:55:28 +08:00
- ``$__fish_git_prompt_char_dirtystate`` (`*`, ✚)
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_char_invalidstate`` (#, ✖)
- ``$__fish_git_prompt_char_stagedstate`` (+, ●)
- ``$__fish_git_prompt_color_dirtystate`` (red with showcolorhints, same as color_flags otherwise)
- ``$__fish_git_prompt_color_invalidstate``
- ``$__fish_git_prompt_color_stagedstate`` (green with showcolorhints, color_flags otherwise)
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
Variables used with ``showstashstate``:
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_char_stashstate`` (``$``, ⚑)
- ``$__fish_git_prompt_color_stashstate`` (same as color_flags)
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
Variables used with ``showuntrackedfiles``:
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_char_untrackedfiles`` (%, …)
- ``$__fish_git_prompt_color_untrackedfiles`` (same as color_flags)
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
Variables used with ``showupstream`` (also implied by informative status):
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_char_upstream_ahead`` (>, ↑)
- ``$__fish_git_prompt_char_upstream_behind`` (<, ↓)
- ``$__fish_git_prompt_char_upstream_diverged`` (<>)
- ``$__fish_git_prompt_char_upstream_equal`` (=)
- ``$__fish_git_prompt_char_upstream_prefix`` ('')
- ``$__fish_git_prompt_color_upstream``
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
Colors used with ``showcolorhints``:
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
docs/fish_git_prompt: Fix formatting Sphinx likes empty lines before lists. Also give variable names the ``treatment``. [ci skip]
2019-03-29 05:11:28 +08:00
- ``$__fish_git_prompt_color_branch`` (green)
- ``$__fish_git_prompt_color_branch_detached`` (red)
- ``$__fish_git_prompt_color_flags`` (--bold blue)
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 23:51:00 +08:00
Note that all colors can also have a corresponding ``_done`` color. For example, the contents of ``$__fish_git_prompt_color_upstream_done`` is printed right _after_ the upstream.
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
See also :ref:`fish_vcs_prompt <cmd-fish_vcs_prompt>`, which will call all supported version control prompt functions, including git, Mercurial and Subversion.
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
Example
--------
A simple prompt that displays git info::
function fish_prompt
docs/fish_git_prompt: Better document variables More accurate, also the code example can now be copy-pasted. [ci skip]
2019-03-20 04:07:49 +08:00
# ...
Add the vcs prompts to sphinx docs
2019-02-25 08:20:25 +08:00
set -g __fish_git_prompt_showupstream auto
printf '%s %s$' $PWD (fish_git_prompt)
end
Reference in New Issue Copy Permalink