zsh-workers
 help / color / mirror / Atom feed
* [PATCH 1/5] vcs_info examples: Add an example of showing Git environment variables.
@ 2019-12-21 15:58 Daniel Shahaf
  2019-12-21 15:58 ` [PATCH 2/5] vcs_info examples: Make the quilt-patch-dir example friendlier Daniel Shahaf
  0 siblings, 1 reply; 2+ messages in thread
From: Daniel Shahaf @ 2019-12-21 15:58 UTC (permalink / raw)
  To: zsh-workers

---
 Misc/vcs_info-examples | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/Misc/vcs_info-examples b/Misc/vcs_info-examples
index c46fad93a..028fe62b0 100644
--- a/Misc/vcs_info-examples
+++ b/Misc/vcs_info-examples
@@ -222,6 +222,31 @@ zstyle -e ':vcs_info:git+set-message:*' hooks 'reply=( ${${(k)functions[(I)[+]vi
 # Both of these functions would be called, even if they are defined after the zstyle is set.
 
 
+## git: Display pertinent environment variables
+# If environment variables such as $GIT_DIR, $GIT_WORK_TREE, etc are set in the
+# environment, they'll be shown in the value of the %m expando.
+#
+# Note that the %m expando is not used by default. To see a change, either change
+# `[misc]' to `[branch]', or set the `formats` style to a value that includes `%m'.
+zstyle ':vcs_info:git+post-backend:*' hooks git-post-backend-envvars
++vi-git-post-backend-envvars() {
+  local param
+  # This uses the ${parameters} special variable (provided by the zsh/parameter
+  # module), in conjunction with the parameter expansion flags ${(k)foo} and
+  # ${(M)foo:#pattern} (documented in "Parameter Expansion" in zshexpn(1))
+  # and the (R) subscript flag (documented in "Subscript Flags" in zshparam(1)),
+  # to iterate over the names of all environment variables named "GIT_*".  Then
+  # it uses the ${(P)foo} parameter expansion flag to show the values of those
+  # parameters.
+  #
+  # The value of ${hook_com[misc]} is substituted for %m in the values of the
+  # 'formats' and 'actionformats' styles.
+  for param in ${(Mk)parameters[(R)*export*]:#GIT_*}; do
+    hook_com[misc]+=";%U${param//'%'/%%}%u=%F{white}${${(P)param}//'%'/%%}%f"
+  done
+}
+
+
 ### hg: Show marker when the working directory is not on a branch head
 # This may indicate that running `hg up` will do something
 # NOTE: the branchheads.cache file is not updated with every Mercurial

^ permalink raw reply	[flat|nested] 2+ messages in thread

* [PATCH 2/5] vcs_info examples: Make the quilt-patch-dir example friendlier.
  2019-12-21 15:58 [PATCH 1/5] vcs_info examples: Add an example of showing Git environment variables Daniel Shahaf
@ 2019-12-21 15:58 ` Daniel Shahaf
  0 siblings, 0 replies; 2+ messages in thread
From: Daniel Shahaf @ 2019-12-21 15:58 UTC (permalink / raw)
  To: zsh-workers

- Document that no code at all is necessary for Pareto correctness

- Remove a recommendation to rely on implementation details (${rrn});
  instead, rely only on ${context}, which is a documented API.
---
 Misc/vcs_info-examples | 30 ++++++++++++++++++------------
 1 file changed, 18 insertions(+), 12 deletions(-)

diff --git a/Misc/vcs_info-examples b/Misc/vcs_info-examples
index 028fe62b0..456b3a85b 100644
--- a/Misc/vcs_info-examples
+++ b/Misc/vcs_info-examples
@@ -468,8 +468,16 @@ zstyle ':vcs_info:-quilt-.quilt-standalone:*:*' quilt-patch-dir debian/patches
 # and so we want addon mode to also use a $QUILT_PATCHES value of
 # `debian/patches' in some directories. In the other directories we never
 # want the default `patches' though but a dedicated place for them.
-# Say `~/patches/<repository-name>'. Now we'll use some evaluated-style
-# magic to achieve all that:
+# Say `~/patches/<repository-name>'.
+#
+# First of all, even without any configuration, vcs_info will do the right
+# thing most of the time. Whenever quilt has already run in a directory,
+# vcs_info will figure out whether that directory uses `patches' or
+# `debian/patches' by interrogating metadata in the `.pc/' subdirectory,
+# which quilt creates. To make vcs_info find the patches dir correctly even
+# when the `.pc/' directory doesn't exist, read on.
+#
+# We'll use some evaluated-style magic to achieve that:
 zstyle -e ':vcs_info:*.quilt-addon:*:*' quilt-patch-dir 'my-patches-func'
 
 # That runs something called `my-patches-func', and the value of $reply is
@@ -486,19 +494,17 @@ function my-patches-func() {
     fi
 
     # Now the part about the dedicated directory is a little trickier.
-    # It requires some knowledge of vcs_info's internals. Not much though.
-    # Everything about this is described in the manual because this
-    # variable (plus a few others) may be of interest in hooks, where
-    # they are available, too.
-    #
-    # The variable in question here is `$rrn' which is an abbreviation
-    # of repository-root-name. if you're in
+    # The variable in question here is `$context', which is the zstyle
+    # context used for lookups. Its last component is the repository-root-name,
+    # or ${rrn} for short. If you're in
     #   /usr/src/zsh/Functions
     # and the repository being
     #   /usr/src/zsh
-    # then the value of `$rrn' is `zsh'. Now in case the variable is
-    # empty (it shouldn't at this point, but you never know), let's
-    # drop back to quilt's default "patches".
+    # then the value of `$rrn' would be `zsh'.
+    local rrn=${context##*:}
+
+    # Now, in case the variable is empty (it shouldn't at this point, but you
+    # never know), let's drop back to quilt's default value, "patches".
     if [[ -z ${rrn} ]]; then
         reply=( patches )
         return 0

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2019-12-21 21:05 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-21 15:58 [PATCH 1/5] vcs_info examples: Add an example of showing Git environment variables Daniel Shahaf
2019-12-21 15:58 ` [PATCH 2/5] vcs_info examples: Make the quilt-patch-dir example friendlier Daniel Shahaf

zsh-workers

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.vuxu.org/zsh-workers

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 zsh-workers zsh-workers/ http://inbox.vuxu.org/zsh-workers \
		zsh-workers@zsh.org
	public-inbox-index zsh-workers

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.zsh.workers


code repositories for the project(s) associated with this inbox:

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

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git