about summary refs log tree commit diff
path: root/Doc/Zsh/mod_parameter.yo
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2008-08-13 21:02:02 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2008-08-13 21:02:02 +0000
commita5a1296fa01250eb30974ea798ef5918a0c9603f (patch)
tree47f06f1e55f242ff63f8868cb8ba3dc4429b88a4 /Doc/Zsh/mod_parameter.yo
parent01f5d0a2741ed45f3c85493e88daafc2091259a9 (diff)
downloadzsh-a5a1296fa01250eb30974ea798ef5918a0c9603f.tar.gz
zsh-a5a1296fa01250eb30974ea798ef5918a0c9603f.tar.xz
zsh-a5a1296fa01250eb30974ea798ef5918a0c9603f.zip
25448: add $funcfiletrace to show absolute line number for caller
Diffstat (limited to 'Doc/Zsh/mod_parameter.yo')
-rw-r--r--Doc/Zsh/mod_parameter.yo13
1 files changed, 13 insertions, 0 deletions
diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo
index 0e096c968..5a9f5c318 100644
--- a/Doc/Zsh/mod_parameter.yo
+++ b/Doc/Zsh/mod_parameter.yo
@@ -164,6 +164,16 @@ item(tt(userdirs))(
 This associative array maps user names to the pathnames of their home
 directories.
 )
+vindex(funcfiletrace)
+item(tt(funcfiletrace))(
+This array contains the absolute line numbers and corresponding file
+names for the point where the current function or sourced file was
+called.  The array is of the same length as tt(funcsourcetrace) and
+tt(functrace), but differs from tt(funcsourcetrace) in that the line and
+file are the point of call, not the point of definition, and differs
+from tt(functrace) in that all values are absolute line numbers in
+files, rather than relative to the start of a function, if any.
+)
 vindex(funcsourcetrace)
 item(tt(funcsourcetrace))(
 This array contains the file names and line numbers of the 
@@ -176,6 +186,9 @@ The format of each element is var(filename)tt(:)var(lineno).
 For files that have been executed by the tt(source) or tt(.) builtins
 (in which case there is no separate definition) the trace information is
 shown as tt(source:0).
+
+Most users will be interested in the information in the
+tt(funcfiletrace) array instead.
 )
 vindex(funcstack)
 item(tt(funcstack))(