summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog6
-rw-r--r--Functions/VCS_Info/VCS_INFO_formats7
-rw-r--r--Functions/VCS_Info/VCS_INFO_set2
3 files changed, 14 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index eb93c5bef..f271ba421 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2017-12-30 Daniel Shahaf <d.s@daniel.shahaf.name>
+
+ * unposted: Functions/VCS_Info/VCS_INFO_formats,
+ Functions/VCS_Info/VCS_INFO_set: vcs_info: Add docstrings to
+ the internal functions VCS_INFO_formats and VCS_INFO_set.
+
2017-12-28 Jun-ichi Takimoto <takimoto-j@kba.biglobe.ne.jp>
* 42175 + 42177 (+ 24178 by Daniel):
diff --git a/Functions/VCS_Info/VCS_INFO_formats b/Functions/VCS_Info/VCS_INFO_formats
index 4d0dd75c2..e0e1dc738 100644
--- a/Functions/VCS_Info/VCS_INFO_formats
+++ b/Functions/VCS_Info/VCS_INFO_formats
@@ -34,7 +34,7 @@ hook_com[subdir_orig]="${hook_com[subdir]}"
VCS_INFO_hook 'post-backend'
-## description:
+## description (for backend authors):
# action: a string that signals a certain non-default condition in the
# repository (like 'rebase-i' in git). If this in non-empty,
# the actionformats will be used, too.
@@ -49,6 +49,11 @@ VCS_INFO_hook 'post-backend'
# should be provided. eg:
# VCS_INFO_formats '' "${foobranch}" "${foobase}" '' '' '' "${foomisc}"
+## description (vcs_info internals):
+# This function is called by the backend with information about the repository,
+# and (after some manipulations) populates the ${msgs} variable in preparation
+# for calling VCS_INFO_set.
+
if [[ -n ${hook_com[action]} ]] ; then
zstyle -a ":vcs_info:${vcs}:${usercontext}:${rrn}" actionformats msgs
(( ${#msgs} < 1 )) && msgs[1]=' (%s)-[%b|%a]%u%c-'
diff --git a/Functions/VCS_Info/VCS_INFO_set b/Functions/VCS_Info/VCS_INFO_set
index e3f62ceef..0e5849147 100644
--- a/Functions/VCS_Info/VCS_INFO_set
+++ b/Functions/VCS_Info/VCS_INFO_set
@@ -2,6 +2,8 @@
## Written by Frank Terbeck <ft@bewatermyfriend.org>
## Distributed under the same BSD-ish license as zsh itself.
+# This function sets ${vcs_info_msg_<N>_} from ${msgs}.
+
setopt localoptions noksharrays NO_shwordsplit unset
local -i i j