h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-29 18:51:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

git prompt: Interpret values of "1", "yes" or "true" as true for bools instead of relying on defined-or-not (#9274)

Browse Source 
This allows explicitly turning these settings off by setting the variable to e.g. 0.

See #7120
This commit is contained in:
Fabian Boehm
2022-10-21 20:22:20 +02:00
committed by GitHub
parent f3372635fa
commit 8c362c89b5
3 changed files with 41 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc_src/cmds/fish_git_prompt.rst
View File

@@ -26,14 +26,16 @@ The ``fish_git_prompt`` function displays information about the current git repo
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 :doc:`set <set>` command.
- ``$__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 dirty files, unpushed/unpulled commits, and more.
Boolean options (those which enable or disable something) understand "1", "yes" or "true" to mean true and every other value to mean false.
- ``$__fish_git_prompt_show_informative_status`` or the git option ``bash.showInformativeStatus`` can be set to 1, true or yes to enable the "informative" display, which will show a large amount of information - the number of dirty files, unpushed/unpulled commits, and more.
In large repositories, this can take a lot of time, so you may wish to disable it in these repositories with ``git config --local bash.showInformativeStatus false``. It also changes the characters the prompt uses to less plain ones (``✚`` instead of ``*`` for the dirty state for example) , and if you are only interested in that, set ``$__fish_git_prompt_use_informative_chars`` instead.
Because counting untracked files requires a lot of time, the number of untracked files is only shown if enabled via ``$__fish_git_prompt_showuntrackedfiles`` or the git option ``bash.showUntrackedFiles``.
- ``$__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.
- ``$__fish_git_prompt_showdirtystate`` or the git option ``bash.showDirtyState`` can be set to 1, true or yes to show if the repository is "dirty", i.e. has uncommitted changes.
- ``$__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).
- ``$__fish_git_prompt_showuntrackedfiles`` or the git option ``bash.showUntrackedFiles`` can be set to 1, true or yes to show if the repository has untracked files (that aren't ignored).
- ``$__fish_git_prompt_showupstream`` can be set to a list of values to determine how changes between HEAD and upstream are shown:
@@ -52,7 +54,7 @@ There are numerous customization options, which can be controlled with git optio
``none``
disables (useful with informative status)
- ``$__fish_git_prompt_showstashstate`` can be set to display the state of the stash.
- ``$__fish_git_prompt_showstashstate`` can be set to 1, true or yes to display the state of the stash.
- ``$__fish_git_prompt_shorten_branch_len`` can be set to the number of characters that the branch name will be shortened to.
@@ -69,7 +71,7 @@ There are numerous customization options, which can be controlled with git optio
If none of these apply, the commit SHA shortened to 8 characters is used.
- ``$__fish_git_prompt_showcolorhints`` can be set to enable coloring for the branch name and status symbols.
- ``$__fish_git_prompt_showcolorhints`` can be set to 1, true or yes to enable coloring for the branch name and status symbols.
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``.