about summary refs log tree commit diff
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2006-01-05 16:13:17 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2006-01-05 16:13:17 +0000
commitb71a632d2f0100e46963faa64684456e49bc1791 (patch)
tree94636965eb5dedf85cdbdbd8471e4fb3faa0c3d3
parent4c5e2ca4ad594f020a83887e97d74ed611379d85 (diff)
downloadzsh-b71a632d2f0100e46963faa64684456e49bc1791.tar.gz
zsh-b71a632d2f0100e46963faa64684456e49bc1791.tar.xz
zsh-b71a632d2f0100e46963faa64684456e49bc1791.zip
22118: fix cdpath documentation
-rw-r--r--ChangeLog5
-rw-r--r--Doc/Zsh/builtins.yo22
2 files changed, 21 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index e7c64018a..47d758d90 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-01-05  Peter Stephenson  <pws@csr.com>
+
+	* 22118: Doc/Zsh/builtins.yo: fix documentation for what
+	happens when . does or does not appear in $cdpath.
+
 2006-01-04  Peter Stephenson  <pws@csr.com>
 
 	* unposted: Completion/Unix/Command/_perforce: when deleting
diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index affe5b610..73c8a8358 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -160,12 +160,22 @@ Change the current directory.  In the first form, change the
 current directory to var(arg), or to the value of tt($HOME) if
 var(arg) is not specified.  If var(arg) is `tt(-)', change to the
 value of tt($OLDPWD), the previous directory.
-Otherwise, if a directory named var(arg) is not found in the current
-directory and var(arg) does not begin with a slash, search each
-component of the shell parameter tt(cdpath).  If no directory is found
-and the option tt(CDABLE_VARS) is set, and a parameter named var(arg)
-exists whose value begins with a slash, treat its value as the
-directory.  In that case, the parameter is added to the named
+
+Otherwise, if var(arg) begins with a slash, attempt to change to the
+director given by var(arg).
+
+If var(arg) does not begin with a slash, the behaviour depends on whether
+the current directory `tt(.)' occurs in the list of directories contained
+in the shell parameter tt(cdpath).  If it does not, first attempt to change
+to the directory var(arg) under the current directory, and if that fails
+but tt(cdpath) is set and contains at least one element attempt to change
+to the directory var(arg) under each component of tt(cdpath) in turn until
+successful.  If `tt(.)' occurs in tt(cdpath), then tt(cdpath) is searched
+strictly in order so that `tt(.)' is only tried at the appropriate point.
+
+If no directory is found, the option tt(CDABLE_VARS) is set, and a
+parameter named var(arg) exists whose value begins with a slash, treat its
+value as the directory.  In that case, the parameter is added to the named
 directory hash table.
 
 The second form of tt(cd) substitutes the string var(new)