about summary refs log tree commit diff
path: root/Functions/VCS_Info/VCS_INFO_formats
diff options
context:
space:
mode:
Diffstat (limited to 'Functions/VCS_Info/VCS_INFO_formats')
-rw-r--r--Functions/VCS_Info/VCS_INFO_formats7
1 files changed, 6 insertions, 1 deletions
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-'