Re: [PATCH] vcs_info: git: Support stagedstr(%c) without unstagedstr(%u)

[Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx>]

Frank Terbeck wrote on Fri, Apr 04, 2014 at 11:53:11 +0200:
> Daniel Shahaf wrote:
> > Hello.
> 
> Hi!
> 
> Sorry for the delay.
> 

No problem, hi :)

> > --- a/Functions/VCS_Info/Backends/VCS_INFO_get_data_bzr
> > +++ b/Functions/VCS_Info/Backends/VCS_INFO_get_data_bzr
> [...]
> > +    # TODO: document in zshcontrib that bzr supports check-for-changes
> > +    # (also in VCS_INFO_bzr_get_info_restricted)
> 
> Sounds like a plan. Do you want the job? :)
> 

I _was_ trying to outsource it, but...

Attached.

> > --- a/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
> > +++ b/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
> [...]
> > +local querystaged queryunstaged
> 
> If you'd make this "local -i ..." the variables would be integers,
> defaulting to zero.

Thanks for the tip.  Done, new version attached.

Cheers,

Daniel

From 516d64785d0d77bd2504c3a947ba06ce73258185 Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx>
Date: Fri, 4 Apr 2014 13:53:13 +0000
Subject: [PATCH 3/3] vcs_info: Document 'post-backend' hook and bzr
 'check-for-changes' support.

---
 Doc/Zsh/contrib.yo |   17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index c862fa4..a4000fd 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -826,13 +826,16 @@ item(tt(check-for-changes))(
 If enabled, this style causes the tt(%c) and tt(%u) format escapes to show
 when the working directory has uncommitted changes. The strings displayed by
 these escapes can be controlled via the tt(stagedstr) and tt(unstagedstr)
-styles. The only backends that currently support this option are tt(git) and
-tt(hg) (tt(hg) only supports unstaged).
+styles. The only backends that currently support this option are tt(git),
+tt(hg), and tt(bzr) (the latter two only support unstaged).
 
 For this style to be evaluated with the tt(hg) backend, the tt(get-revision)
 style needs to be set and the tt(use-simple) style needs to be unset. The
 latter is the default; the former is not.
 
+With tt(bzr) backend, lightweight checkouts only honor this style if
+the tt(use-server) style is set.
+
 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.
@@ -874,7 +877,7 @@ when this style is looked up.
 
 For example, this style can be used to use binaries from non-default
 installation directories. Assume, tt(git) is installed in /usr/bin but
-your sysadmin installed a newer version in /usr/bin/local. Instead of
+your sysadmin installed a newer version in /usr/local/bin. Instead of
 changing the order of your tt($PATH) parameter, you can do this:
 example(zstyle ':vcs_info:git:*:-all-' command /usr/local/bin/git)
 )
@@ -892,6 +895,9 @@ backend is only usable if you have set the environment variable
 tt(P4CONFIG) to a file name and have corresponding files in the root
 directories of each Perforce client.  See comments in the function
 tt(VCS_INFO_detect_p4) for more detail.
+
+The Bazaar backend (tt(bzr)) uses this to permit contacting the server
+about lightweight checkouts, see the tt(check-for-changes) style.
 )
 kindex(use-simple)
 item(tt(use-simple))(
@@ -1333,6 +1339,11 @@ This hooks is called when no version control system was detected.
 
 The `hook_com' parameter is not used.
 )
+item(tt(post-backend))(
+Called as soon as the backend has finished collecting information.
+
+The `tt(hook_com)' keys available are as for the tt(set-message) hook.
+)
 item(tt(post-quilt))(
 Called after the tt(quilt) support is done. The following information
 is passed as arguments to the hook: 1. the quilt-support mode (`addon' or
-- 
1.7.10.4

From ff341888b72642c7bae5e5b09d9e68b6a01e5b4d Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx>
Date: Fri, 28 Mar 2014 11:00:35 +0000
Subject: [PATCH 2/3] 32508: vcs_info: Add check-for-staged-changes

---
 Completion/Zsh/Command/_zstyle                    |    2 ++
 Doc/Zsh/contrib.yo                                |   13 +++++++++++++
 Functions/VCS_Info/Backends/VCS_INFO_get_data_git |   21 ++++++++++++++++-----
 Misc/vcs_info-examples                            |    4 ++++
 4 files changed, 35 insertions(+), 5 deletions(-)

diff --git a/Completion/Zsh/Command/_zstyle b/Completion/Zsh/Command/_zstyle
index 708c0fd..eb27117 100644
--- a/Completion/Zsh/Command/_zstyle
+++ b/Completion/Zsh/Command/_zstyle
@@ -182,6 +182,8 @@ styles=(
   disable                v:vcs
   disable-patterns       v:
   check-for-changes      v:bool
+  check-for-staged-changes
+                         v:bool
   stagedstr              v:
   unstagedstr            v:
   command                v:_command_names
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index c446471..c862fa4 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))
diff --git a/Functions/VCS_Info/Backends/VCS_INFO_get_data_git b/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
index e6791cb..6512851 100644
--- a/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
+++ b/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
@@ -5,6 +5,7 @@
 setopt localoptions extendedglob NO_shwordsplit
 local gitdir gitbase gitbranch gitaction gitunstaged gitstaged gitsha1
 local stgitpatch stgitunapplied
+local -i querystaged queryunstaged
 local -A hook_com
 
 VCS_INFO_git_getaction () {
@@ -120,14 +121,24 @@ if [[ -z ${gitdir} ]] || [[ -z ${gitbranch} ]] ; then
     return 1
 fi
 
-if zstyle -t ":vcs_info:${vcs}:${usercontext}:${rrn}" "check-for-changes" && \
+if zstyle -t ":vcs_info:${vcs}:${usercontext}:${rrn}" "check-for-changes" ; then
+    querystaged=1
+    queryunstaged=1
+elif zstyle -t ":vcs_info:${vcs}:${usercontext}:${rrn}" "check-for-staged-changes" ; then
+    querystaged=1
+fi
+if (( querystaged || queryunstaged )) && \
    [[ "$(${vcs_comm[cmd]} rev-parse --is-inside-git-dir 2> /dev/null)" != 'true' ]] && \
    ${vcs_comm[cmd]} rev-parse --quiet --verify HEAD &> /dev/null ; then
     # Default: off - these are potentially expensive on big repositories
-    ${vcs_comm[cmd]} diff --no-ext-diff --ignore-submodules --quiet --exit-code ||
-        gitunstaged=1
-    ${vcs_comm[cmd]} diff-index --cached --quiet --ignore-submodules HEAD 2> /dev/null
-    (( $? && $? != 128 )) && gitstaged=1
+    if (( queryunstaged )) ; then
+        ${vcs_comm[cmd]} diff --no-ext-diff --ignore-submodules --quiet --exit-code ||
+            gitunstaged=1
+    fi
+    if (( querystaged )) ; then
+        ${vcs_comm[cmd]} diff-index --cached --quiet --ignore-submodules HEAD 2> /dev/null
+        (( $? && $? != 128 )) && gitstaged=1
+    fi
 fi
 
 VCS_INFO_adjust
diff --git a/Misc/vcs_info-examples b/Misc/vcs_info-examples
index b07bfc6..5d8ff18 100644
--- a/Misc/vcs_info-examples
+++ b/Misc/vcs_info-examples
@@ -266,6 +266,10 @@ autoload -Uz vcs_info
 zstyle ':vcs_info:*' check-for-changes true
 zstyle ':vcs_info:*' get-revision true
 
+# Alternatively, the following would set only %c, but is faster:
+#zstyle ':vcs_info:*' check-for-changes false
+#zstyle ':vcs_info:*' check-for-staged-changes true
+
 
 # Default to running vcs_info. If possible we prevent running it later for
 # speed reasons. If set to a non empty value vcs_info is run.
-- 
1.7.10.4