aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFarid Zakaria <fmzakari@google.com>2023-07-26 20:07:17 +0300
committerFarid Zakaria <fmzakari@google.com>2023-07-26 20:08:46 +0300
commita8fa0e2a1b67513331f19dab96de92333ad832f5 (patch)
treed5f1d2d319d834a3b41997f030d24a035c601896
parent68104494a7d407d4b8044cb445eea09e111120ac (diff)
Add documentation explaining lack of support for skipHash
libgit2 does not support skipHash which causes the prompt to be incorrect for repos that have it toggled. Add the documentation for this gap. fixes #2387
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index f5713b64..fa5fa267 100644
--- a/README.md
+++ b/README.md
@@ -1511,6 +1511,7 @@ Powerlevel10k are released. This may change in the future but not soon.
- [Horrific mess when resizing terminal window](#horrific-mess-when-resizing-terminal-window)
- [Icons cut off in Konsole](#icons-cut-off-in-konsole)
- [Arch Linux logo has a dot in the bottom right corner](#arch-linux-logo-has-a-dot-in-the-bottom-right-corner)
+- [Git status looks incorrect](#git-status-looks-incorrect)
### Question mark in prompt
@@ -2020,3 +2021,15 @@ Some fonts have this incorrect dotted icon in bold typeface. There are two ways
```zsh
typeset -g POWERLEVEL9K_OS_ICON_CONTENT_EXPANSION='${P9K_CONTENT}' # not bold
```
+
+### Git status looks incorrect
+
+Powerlevel10k uses [gitstatus](https://github.com/romkatv/gitstatus) to provide a much faster response to traditional `git status`.
+The project relies on the [libgit2](https://github.com/libgit2/libgit2) library however which has some gaps in it's implementation.
+
+#### skipHash not supported
+
+If your `.git/config` has `skipHash` enabled, then you will likely see an incorrect status prompt as this is not supported
+by libgit2 at the moment. [issue](https://github.com/libgit2/libgit2/issues/6531)
+
+Note: `skipHash` can be set by implicitly by other configuration toggles such as `feature.manyFiles`