From ce950dd4b4b56e39a5011c54179832ba2ed04e61 Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Sun, 1 Dec 2019 00:04:46 +0000 Subject: 44962: vcs_info: Document internal function and variable --- Functions/VCS_Info/VCS_INFO_bydir_detect | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'Functions/VCS_Info/VCS_INFO_bydir_detect') diff --git a/Functions/VCS_Info/VCS_INFO_bydir_detect b/Functions/VCS_Info/VCS_INFO_bydir_detect index b20c05c9c..29b261413 100644 --- a/Functions/VCS_Info/VCS_INFO_bydir_detect +++ b/Functions/VCS_Info/VCS_INFO_bydir_detect @@ -2,6 +2,18 @@ ## Written by Frank Terbeck ## Distributed under the same BSD-ish license as zsh itself. +# Helper function for VCS_INFO_detect_* +# +# Usage: +# vcs_comm[detect_need_file]=FILENAMES VCS_INFO_bydir_detect DIRNAME +# where DIRNAME is a directory name and FILENAMES is a space-separated list +# of filenames. +# +# If any parent directory of the current working directory, other than the root +# directory, contains a subdirectory named DIRNAME that contains a file whose name +# is in FILENAMES, set vcs_comm[basedir] to the path of that parent directory and +# return true. Otherwise, return false. + setopt localoptions NO_shwordsplit local dirname=$1 local basedir="." file -- cgit v1.2.3