about summary refs log tree commit diff
path: root/Doc/Zsh/mod_mapfile.yo
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/Zsh/mod_mapfile.yo')
-rw-r--r--Doc/Zsh/mod_mapfile.yo15
1 files changed, 9 insertions, 6 deletions
diff --git a/Doc/Zsh/mod_mapfile.yo b/Doc/Zsh/mod_mapfile.yo
index 6d0475711..496d8a915 100644
--- a/Doc/Zsh/mod_mapfile.yo
+++ b/Doc/Zsh/mod_mapfile.yo
@@ -1,7 +1,8 @@
-texinode(The mapfile Module)(The parameter Module)(The files Module)(Zsh Modules)
-sect(The mapfile Module)
+COMMENT(!MOD!zsh/mapfile
+Access to external files via a special associative array.
+!MOD!)
 cindex(parameter, file access via)
-The tt(mapfile) module provides one special associative array parameter of
+The tt(zsh/mapfile) module provides one special associative array parameter of
 the same name.
 
 startitem()
@@ -34,11 +35,13 @@ handled, zsh's internal memory management may be arbitrarily baroque.  Thus
 it should not automatically be assumed that use of tt(mapfile) represents a
 gain in efficiency over use of other mechanisms.  Note in particular that
 the whole contents of the file will always reside physically in memory when
-accessed (possibly multiple times, due to standard parameter subsitution
-operations).
+accessed (possibly multiple times, due to standard parameter substitution
+operations).  In particular, this means handling of sufficiently long files
+(greater than the machine's swap space, or than the range of the pointer
+type) will be incorrect.
 
 No errors are printed or flagged for non-existent, unreadable, or
-unwriteable files, as the parameter mechanism is too low in the shell
+unwritable files, as the parameter mechanism is too low in the shell
 execution hierarchy to make this convenient.
 
 It is unfortunate that the mechanism for loading modules does not yet allow