PATCH: source tree documentation

[Peter Stephenson <pws@xxxxxxx>]

Initial go at enhancing documentation for 4.3.

Index: INSTALL
===================================================================
RCS file: /cvsroot/zsh/zsh/INSTALL,v
retrieving revision 1.18
diff -u -r1.18 INSTALL
--- INSTALL	30 Jul 2004 11:09:17 -0000	1.18
+++ INSTALL	30 Sep 2005 12:05:56 -0000
@@ -235,6 +235,27 @@
 CONFIGURATION OPTIONS
 =====================
 
+Multibyte character support
+---------------------------
+
+Support for multibyte character sets that extend ASCII, such as UTF-8, is
+under development but the code in the line editor is sufficiently stable to
+be turned on by default in environments that provide full ISO 10646 support
+including the preprocessor definition __STDC_ISO_10646__.
+
+The support can be explicitly enabled or disable with --enable-multibyte or
+--disable-multibyte.  Reports of systems where multibyte support was not
+enabled by default but --enable-multibyte resulted in a usable shell would
+be appreciated.  The developers are not aware of any need to use
+--disable-multibyte and this should be reported as a bug.
+
+The main shell is not yet aware of multibyte characters, so for example the
+length of a scalar parameter will return the number of bytes, not
+characters, and pattern tests likewise treat single bytes as if they were
+characters.  This means that pattern tests such as ? and [[:alpha:]] do not
+work correctly with characters in multibyte character sets beyond the ASCII
+subset.
+
 Memory Routines
 ---------------
 
Index: NEWS
===================================================================
RCS file: /cvsroot/zsh/zsh/NEWS,v
retrieving revision 1.5
diff -u -r1.5 NEWS
--- NEWS	11 Jan 2005 17:49:16 -0000	1.5
+++ NEWS	30 Sep 2005 12:05:56 -0000
@@ -2,8 +2,35 @@
 CHANGES FROM PREVIOUS VERSIONS OF ZSH
 -------------------------------------
 
-Changes since zsh version 4.2.0
--------------------------------
+Major changes between versions 4.2 and 4.3
+------------------------------------------
+
+- There is support for multibyte character sets in the line editor,
+  though not the main shell.  See Multibyte Character Support in INSTALL.
+
+- 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.
+
+- New option HIST_SAVE_BY_COPY (on by default): history is saved by
+  copying and renaming instead of directly overwriting.
+
+- 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.
+
+- New Posix-style zsh-specific tests [[:IDENT:]], [[:IFS:]],
+  [[:IFSSPACE:]], [[:WORD:]] test if character can appear in identifier,
+  is an IFS character, is an IFS whitespace character, or is considered
+  as part of a word (is alphanumeric or appears in $WORDCHARS).  Note
+  the pattern code doesn't yet handle multibyte characters.
+
+- The idiom =(<<<...) 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.
+
+Changes in 4.2 since version 4.2.0
+----------------------------------
 
 - The autoload and related builtins take options -k and -z to indicate
   ksh or zsh autoloading style for given functions, making it possible
ndex: README
===================================================================
RCS file: /cvsroot/zsh/zsh/README,v
retrieving revision 1.22
diff -u -r1.22 README
--- README	9 Mar 2005 17:14:02 -0000	1.22
+++ README	30 Sep 2005 12:05:57 -0000
@@ -5,7 +5,7 @@
 Version
 -------
 
-This is a version under development subsequent to zsh 4.2.3.
+This is development code before the release of version 4.3.1.
 
 Installing Zsh
 --------------

-- 
Peter Stephenson <pws@xxxxxxx>                  Software Engineer
CSR PLC, Churchill House, Cambridge Business Park, Cowley Road
Cambridge, CB4 0WZ, UK                          Tel: +44 (0)1223 692070


This message has been scanned for viruses by BlackSpider MailControl - www.blackspider.com