From aa622e08014744c54e585e34613c2572a27f0f4b Mon Sep 17 00:00:00 2001
From: Peter Stephenson
Date: Sun, 4 Jan 2015 00:28:03 +0000
Subject: users/19682: document recommended use of whence
---
Doc/Zsh/builtins.yo | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
(limited to 'Doc')
diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index b4f4b6742..49c2c11c3 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -2087,6 +2087,11 @@ item(tt(whence) [ tt(-vcwfpamsS) ] var(name) ...)(
For each name, indicate how it would be interpreted if used as a
command name.
+tt(whence) is most useful when var(name) is only the last path component
+of a command, i.e. does not include a `tt(/)'; in particular, pattern
+matching only succeeds if just the non-directory component of the command is
+passed.
+
startitem()
item(tt(-v))(
Produce a more verbose report.
@@ -2119,7 +2124,7 @@ throughout the command path.
Normally only the first occurrence is printed.
)
item(tt(-m))(
-The arguments are taken as patterns (should be
+The arguments are taken as patterns (pattern characters should be
quoted), and the information is displayed for each command matching one
of these patterns.
)
--
cgit 1.4.1