22057: don't use zsh/newuser in emulation

22058: tweak docs for release

6 files changed, 53 insertions, 19 deletions

diff --git a/ChangeLog b/ChangeLog
index 5a59220da..6c8df2f35 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2005-12-09  Peter Stephenson  <pws@csr.com>
+
+	* 22058: NEWS, Doc/Zsh/roadmap.yo: tweak docs for release.
+
+	* 22057: Doc/Zsh/mod_newuser.yo, Src/options.c,
+	Src/Modules/newuser.c: make it explicit that zsh/newuser isn't
+	used during emulation.
+
 2005-12-07  Peter Stephenson  <p.w.stephenson@ntlworld.com>
 
 	* 22056: Functions/MIME/zsh-mime-handler: restore original default
diff --git a/Doc/Zsh/mod_newuser.yo b/Doc/Zsh/mod_newuser.yo
index 202fb90e8..d21e633c2 100644
--- a/Doc/Zsh/mod_newuser.yo
+++ b/Doc/Zsh/mod_newuser.yo
@@ -12,7 +12,9 @@ removed from tt($MODULE_PATH) by the administrator if it is not required.
 On loading, the module tests if any of the start-up files tt(.zshenv),
 tt(.zprofile), tt(.zshrc) or tt(.zlogin) exist in the directory given by
 the environment variable tt(ZDOTDIR), or the user's home directory if that
-is not set.
+is not set.  The test is not performed and the module halts processing if
+the shell was in an emulation mode (i.e. had been invoked as some other
+shell than zsh).
 
 If none of the start-up files were found, the module then looks for the
 file tt(newuser) first in a sitewide directory, usually the parent
diff --git a/Doc/Zsh/roadmap.yo b/Doc/Zsh/roadmap.yo
index 547f7e20b..1e529c6f6 100644
--- a/Doc/Zsh/roadmap.yo
+++ b/Doc/Zsh/roadmap.yo
@@ -14,6 +14,12 @@ be created or edited to customize the shell.  See ifzman(the section
 Startup/Shutdown Files in zmanref(zsh))\
 ifnzman(noderef(Files)).
 
+If no personal intialization files exist for the current user, a function
+is run to help you change some of the most common settings.  It won't
+appear if your administrator has disabled the tt(zsh/newuser) module.
+The function is designed to be self-explanatory.  You can run it by hand
+with `tt(autoload -Uz zsh-newuser-install; zsh-newuser-install -f)'.
+
 sect(Interactive Use)
 
 Interaction with the shell uses the builtin Zsh Line Editor, ZLE.  This is
@@ -35,7 +41,7 @@ tt(HISTSIZE) and tt(SAVEHIST) in ifzman(zmanref(zshparams))\
 ifnzman(noderef(Parameters Used By The Shell)).
 
 The line editor provides an extensive completion system and the shell
-is supplied for completions with many commonly used commands.  Note
+is supplied with completions for many commonly used commands.  Note
 that the new completion system referred to as tt(compsys) is preferred
 over the older tt(compctl) system.  The completion system must be enabled
 explicitly when the shell starts.  For more information see
@@ -111,12 +117,15 @@ General shell syntax is introduced in ifzman(the section `Shell Grammar' in
 zmanref(zshmisc))\
 ifnzman(noderef(Shell Grammar)).
 
-One commonly encountered difference is that variables (other than arrays, a
-particular type of variable) substituted onto the command line are not
-split into words.  See the description of the shell option
-tt(SH_WORD_SPLIT) in ifzman(the section `Parameter Expansion' in
-zmanref(zshexpn))\
+One commonly encountered difference is that variables substituted onto the
+command line are not split into words.  See the description of the shell option
+tt(SH_WORD_SPLIT) in
+ifzman(the section `Parameter Expansion' in zmanref(zshexpn))\
 ifnzman(noderef(Parameter Expansion)).
+In zsh, you should use arrays when you want variables to expand to more
+than one word.  See
+ifzman(the section `Array Parameters' in zmanref(zshparam))\
+ifnzman(noderef(Array Parameters)).
 
 sect(Programming)
 
@@ -124,7 +133,9 @@ The most convenient way of adding enhancements to the shell is typically
 by writing a shell function and arranging for it to be autoloaded.
 Functions are described in ifzman(the section `Functions' in
 zmanref(zshmisc))\
-ifnzman(noderef(Functions)).
+ifnzman(noderef(Functions)).  Users changing from the C shell and its
+relatives should notice that aliases are less used in zsh as they don't
+perform argument substitution, only simple text replacement.
 
 A few general functions, other than those for the line editor described
 above, are provided with the shell and are described in
@@ -149,6 +160,6 @@ item(tt(zargs))(
 a version of tt(xargs) that makes the tt(find) command redundant
 )
 item(tt(zmv))(
-a command for renaming files with patterns.
+a command for renaming files by means of shell patterns.
 )
 enditem()
diff --git a/NEWS b/NEWS
index da605e884..c3656c003 100644
--- a/NEWS
+++ b/NEWS
@@ -12,6 +12,10 @@ Major changes between versions 4.2 and 4.3
   (one with no .zshrc, .zshenv, .zprofile or .zlogin file) without
   any additional setting up by the administrator.
 
+- The manual now has a Roadmap section (manual page zshroadmap) to
+  give new users an indication of the most interesting parts of the
+  manual.
+
 - New option PROMPT_SP, on by default, to work around the problem that the
   line editor can overwrite output with no newline at the end.
 
@@ -20,11 +24,8 @@ Major changes between versions 4.2 and 4.3
 
 - New redirection syntax e.g. {myfd}>file opens a new file descriptor
   and stores the number in $myfd, so that >&$myfd will work.  Chosen
-  not to break existing code.
-
-- The manual now has a Roadmap section (manual page zshroadmap) to
-  give new users an indication of the most interesting parts of the
-  manual.
+  not to break existing code (and to be compatible with proposals for the
+  Korn shell).
 
 - New Posix-style zsh-specific tests [[:IDENT:]], [[:IFS:]],
   [[:IFSSPACE:]], [[:WORD:]] test if character can appear in identifier,
@@ -35,7 +36,16 @@ Major changes between versions 4.2 and 4.3
 - The idiom =(<<<...) is optimised so that the shell internally turns
   the ... into the contents of a file whose name is then substituted.
 
-- As always, many enhancements to completion functions.
+- Supplied functions catch and throw provide limited support for
+  exception handling using the `{ ... } always { ... }' syntax.
+
+- Signals now accept the SIG as part of the name for compatibility with
+  other shells.
+
+- Editor function argument-base allows non-decimal arguments for
+  editor widgets.
+
+- As always, there are many enhancements to completion functions.
 
 Changes in 4.2 since version 4.2.0
 ----------------------------------
@@ -67,7 +77,7 @@ Changes in 4.2 since version 4.2.0
   in the event of an error.  It also runs after a break, continue, or
   return, including a return forced by the ERR_RETURN option
   (but not an exit, which is immediate).  The syntax is:
-    `{'  try-block-list `}' `always' `{' always-block-list `}'
+    `{' try-block-list `}' `always' `{' always-block-list `}'
   where no newline or semicolon may appear between `}' and `always'.
   This is compatible with all previous valid zsh syntax as an `always'
   at that point used to be a syntax error.  For example,
@@ -101,8 +111,8 @@ Changes in 4.2 since version 4.2.0
 
 - New WIDGETSTYLE, WIDGETFUNC parameters in ZLE.
 
-- Glob qualifiers (+func) is shorthand for (e:func:) (calls command,
-  typically shell function, with no argument).
+- Glob qualifier (+func) is shorthand for (e:func:) (calls a command,
+  typically a shell function, with no argument).
 
 New features between zsh versions 4.0 and 4.2
 ---------------------------------------------
diff --git a/Src/Modules/newuser.c b/Src/Modules/newuser.c
index cbe09312f..e49a66121 100644
--- a/Src/Modules/newuser.c
+++ b/Src/Modules/newuser.c
@@ -64,6 +64,9 @@ boot_(UNUSED(Module m))
 	0 };
     const char **sp;
 
+    if (emulation != EMULATE_ZSH)
+	return;
+
     if (!dotdir)
 	dotdir = home;
 
diff --git a/Src/options.c b/Src/options.c
index 7011b2081..9400e5f89 100644
--- a/Src/options.c
+++ b/Src/options.c
@@ -33,7 +33,7 @@
 /* current emulation (used to decide which set of option letters is used) */
 
 /**/
-int emulation;
+mod_export int emulation;
  
 /* the options; e.g. if opts[SHGLOB] != 0, SH_GLOB is turned on */