about summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2014-03-28 11:00:35 +0000
committerFrank Terbeck <ft@bewatermyfriend.org>2014-04-05 10:56:52 +0200
commiteb4c70d0b7856a8ddfeb4ea2d3d83991f5cb82d3 (patch)
tree67083cf89a40cb81bcd18a32f59bc6c425bb34e6 /Doc
parent4dfe62640a786f60e72af64021910c6ac11167cc (diff)
downloadzsh-eb4c70d0b7856a8ddfeb4ea2d3d83991f5cb82d3.tar.gz
zsh-eb4c70d0b7856a8ddfeb4ea2d3d83991f5cb82d3.tar.xz
zsh-eb4c70d0b7856a8ddfeb4ea2d3d83991f5cb82d3.zip
32528: vcs_info: Add check-for-staged-changes
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/contrib.yo13
1 files changed, 13 insertions, 0 deletions
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index c44647163..c862fa484 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -837,6 +837,18 @@ Note, the actions taken if this style is enabled are potentially expensive
 (read: they may be slow, depending on how big the current repository is).
 Therefore, it is disabled by default.
 )
+kindex(check-for-staged-changes)
+item(tt(check-for-staged-changes))(
+This style is like tt(check-for-changes), but it never checks the worktree
+files, only the metadata in the tt(.${vcs}) dir.  Therefore,
+this style initializes only the tt(%c) escape (with tt(stagedstr)) but
+not the tt(%u) escape.  This style is faster than tt(check-for-changes).
+
+In the tt(git) backend, this style checks for changes in the index.
+Other backends do not currently implement this style.
+
+This style is disabled by default.
+)
 kindex(stagedstr)
 item(tt(stagedstr))(
 This string will be used in the tt(%c) escape if there are staged changes in
@@ -941,6 +953,7 @@ sitem(tt(enable))(ALL)
 sitem(tt(disable))((empty list))
 sitem(tt(disable-patterns))((empty list))
 sitem(tt(check-for-changes))(false)
+sitem(tt(check-for-staged-changes))(false)
 sitem(tt(stagedstr))((string: "S"))
 sitem(tt(unstagedstr))((string: "U"))
 sitem(tt(command))((empty string))