zsh-workers
 help / color / mirror / code / Atom feed
From: Peter Grayson <pete@jpgrayson.net>
To: zsh-workers@zsh.org
Cc: d.s@daniel.shahaf.name, Peter Grayson <pete@jpgrayson.net>
Subject: [PATCH v2] Updated StGit patch detection in vcs_info
Date: Wed, 16 Nov 2022 15:45:02 -0500	[thread overview]
Message-ID: <20221116204501.921232-1-pete@jpgrayson.net> (raw)
In-Reply-To: <20221112154221.661029-1-pete@jpgrayson.net>

The vcs_info patch detection code attempted to interrogate StGit patch
stack state by inspecting .git/patches/applied and
.git/patches/unapplied.

As of StGit 0.15 (2009), patch stack metadata is captured in the repo's
object database. And as of StGit 1.0 (2021), no stack or patch state is
maintained in any files in the .git/ directory.

Zsh's approach for interrogating StGit patch state is thus obsoleted.

This patch updates vcs_info to determine whether StGit is initialized on a
branch by looking at the appropriate git refs and uses StGit's prescribed
interface for interrogating applied and unapplied patch state via the `stg
series` command. This approach will work with all versions of StGit >=0.15.

Signed-off-by: Peter Grayson <pete@jpgrayson.net>
---
 .../VCS_Info/Backends/VCS_INFO_get_data_git   | 38 ++++++++++++++-----
 1 file changed, 29 insertions(+), 9 deletions(-)

diff --git a/Functions/VCS_Info/Backends/VCS_INFO_get_data_git b/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
index e45eebc8e..e275abbb2 100644
--- a/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
+++ b/Functions/VCS_Info/Backends/VCS_INFO_get_data_git
@@ -184,15 +184,8 @@ fi
 VCS_INFO_adjust
 VCS_INFO_git_getaction ${gitdir}
 
-local patchdir=${gitdir}/patches/${gitbranch}
-if [[ -d $patchdir ]] && [[ -f $patchdir/applied ]] \
-   && [[ -f $patchdir/unapplied ]]
-then
-    # stgit
-    git_patches_applied=(${(f)"$(< "${patchdir}/applied")"})
-    git_patches_unapplied=(${(f)"$(< "${patchdir}/unapplied")"})
-    VCS_INFO_git_handle_patches
-elif [[ -d "${gitdir}/rebase-merge" ]]; then
+local patchdir
+if [[ -d "${gitdir}/rebase-merge" ]]; then
     # 'git rebase -i'
     patchdir="${gitdir}/rebase-merge"
     local p
@@ -389,6 +382,33 @@ elif [[ -f "${gitdir}/CHERRY_PICK_HEAD" ]]; then
         git_patches_unapplied=()
     fi
     VCS_INFO_git_handle_patches
+elif command -v stg >/dev/null &&
+        (
+            ${vcs_comm[cmd]} rev-parse --quiet --verify refs/stacks/${gitbranch} >/dev/null ||
+            ${vcs_comm[cmd]} rev-parse --quiet --verify refs/heads/${gitbranch}.stgit >/dev/null \
+        ) && git_patches_applied=(${(f)"$(stg series --noprefix --applied 2>/dev/null)"})
+then
+    # Testing for StGit patches is done after testing for all git-proper
+    # patches/states. If a StGit user's repo is in one of those states, they
+    # will want to see that instead of the StGit patch info.
+
+    # Performance note: testing for the stg executable is done first because it
+    # is extremely cheap and there is nothing else to do if it isn't present.
+    # Using git to test whether a StGit stack is initialized is cheaper than
+    # running stg itself; especially for versions of StGit <= 2.0. Thus getting
+    # StGit patch info should only have a material runtime cost if StGit is
+    # installed and in-use for the current branch.
+
+    # In StGit >=1.2, the existence of refs/stacks/<branch> indicates StGit is
+    # initialized. In StGit >=0.15, it is refs/heads/<branch>.stgit.
+
+    # N.B. the "--noprefix" option is available in StGit 2.x as an alias for
+    # --no-prefix.  The former is compatible with StGit versions going back to
+    # 2008.
+    if zstyle -t ":vcs_info:${vcs}:${usercontext}:${rrn}" get-unapplied; then
+        git_patches_unapplied=(${(f)"$(stg series --noprefix --unapplied 2>/dev/null)"})
+    fi
+    VCS_INFO_git_handle_patches
 else
     gitmisc=''
 fi
-- 
2.38.1



  parent reply	other threads:[~2022-11-16 20:52 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-25 20:43 [PATCH] Remove _stgit completion script Peter Grayson
2022-10-31  9:19 ` Daniel Shahaf
2022-10-31 10:13   ` StGit 2.0 and vcs_info (was: Re: [PATCH] Remove _stgit completion script) Daniel Shahaf
2022-11-01  3:00   ` [PATCH] Remove _stgit completion script Peter Grayson
2022-11-01  3:04     ` [PATCH] Remove StGit patch detection from vcs_info Peter Grayson
2022-11-11 11:49       ` Daniel Shahaf
2022-11-12 14:46         ` Peter Grayson
2022-11-12 15:42           ` [PATCH] Updated StGit patch detection in vcs_info Peter Grayson
2022-11-13  4:58             ` Daniel Shahaf
2022-11-16 20:45             ` Peter Grayson [this message]
2022-12-08 14:52               ` [PATCH v3] " Peter Grayson
2022-12-08 22:06                 ` Daniel Shahaf
2022-12-08 22:08                   ` [PATCH] vcs_info git: Check the get-unapplied style as documented (was: [PATCH v3] Updated StGit patch detection in vcs_info) Daniel Shahaf
2022-12-09  0:59                   ` [PATCH v3] Updated StGit patch detection in vcs_info Peter Grayson
2022-12-09  1:37                     ` Daniel Shahaf
2022-12-10 12:55                       ` Peter Grayson
2022-12-10 13:31                         ` Daniel Shahaf
2022-11-13  4:30           ` [PATCH] Remove StGit patch detection from vcs_info Daniel Shahaf
2022-11-14  3:38             ` Peter Grayson
2022-11-14  5:17               ` Mikael Magnusson
2022-11-14 13:21                 ` Daniel Shahaf
2022-11-14 13:15               ` Daniel Shahaf
2022-11-16 19:38                 ` Peter Grayson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221116204501.921232-1-pete@jpgrayson.net \
    --to=pete@jpgrayson.net \
    --cc=d.s@daniel.shahaf.name \
    --cc=zsh-workers@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).