summary refs log tree commit diff
path: root/Functions/VCS_Info/vcs_info
diff options
context:
space:
mode:
Diffstat (limited to 'Functions/VCS_Info/vcs_info')
-rw-r--r--Functions/VCS_Info/vcs_info6
1 files changed, 6 insertions, 0 deletions
diff --git a/Functions/VCS_Info/vcs_info b/Functions/VCS_Info/vcs_info
index d67ae6bf5..9f48bee75 100644
--- a/Functions/VCS_Info/vcs_info
+++ b/Functions/VCS_Info/vcs_info
@@ -59,6 +59,12 @@ vcs_info () {
     local -x LC_MESSAGES
     local -i maxexports
     local -a msgs
+
+    # vcs_comm is used internally for passing values among VCS_INFO_* functions.
+    # It is not part of the public API.
+    #
+    # hook_com, backend_misc, and user_data are public API; see zshcontrib(1)
+    # and Misc/vcs_info-examples.
     local -A vcs_comm hook_com backend_misc user_data
 
     LC_MESSAGES=C