PATCH: source tree documentation

PATCH: source tree documentation

[Peter Stephenson]

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@csr.com>                  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

Re: PATCH: source tree documentation

[Mikael Magnusson]

On 9/30/05, Peter Stephenson <pws@csr.com> wrote:
> Initial go at enhancing documentation for 4.3.
>
> +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.

Using the prompt truncation things with multibyte crashes for me, or
rather some sort of busyloop occurs. It seems to only happen with
setopt printeightbit lately.


{0:09:54:~www/a}9% cd さくはらちちとれはしりちとのまはしちりれとまはし
{0:09:55:...c\M-^A\M->\M-c\M-^A\M-/\M-c\M-^A\M-^W}9% setopt printeightbit
<in other shell>
% gdb zsh 495
etc
prompttrunc (arg=34, truncchar=60, doprint=1, endchar=0) at prompt.c:1003
1003				if (*p == Inpar)
(gdb) bt
#0  prompttrunc (arg=34, truncchar=60, doprint=1, endchar=0) at prompt.c:1003
#1  0x080c68f2 in putpromptchar (doprint=1, endchar=0) at prompt.c:467
#2  0x080c86fb in promptexpand (
    s=0x8116e58
"%{\033[0m%}%{\033[1;32m%}{%{\033[0;32m%}%*%{\033[0;39m%}:%{\033[0;31m%}%40<...<%{\033[1;31m%}%~%<<%{\033[1;32m%}}%{\033[1;34m%}9%#
%(1j.%{\033[1;33m%}%j jobs
.)%(?.%{\033[0m%}.%{\033[1;31;40m%}%?%{\033[0m%} )", ns=1, rs=0x1
<Address 0x1 out of bounds>,
    Rs=0x1 <Address 0x1 out of bounds>) at prompt.c:183
#3  0xa7bab2f8 in zleread (lp=0x81031c0, rp=0x0, flags=1, context=1)
at zle_main.c:960
#4  0x0808a414 in inputline () at input.c:278
#5  0x0808aa5a in ingetc () at input.c:214
#6  0x08080f87 in ihgetc () at hist.c:240
#7  0x08096436 in gettok () at lex.c:628
#8  0x080980f6 in yylex () at lex.c:344
#9  0x080ba20a in parse_event () at parse.c:451
#10 0x080872aa in loop (toplevel=1, justonce=0) at init.c:128
#11 0x08089fc4 in zsh_main (argc=1, argv=0xafb6f6e4) at init.c:1312
#12 0x08052a6e in main (argc=1, argv=0x1) at main.c:93
(gdb) step
1008				else if (w) {
(gdb)
1003				if (*p == Inpar)
(gdb)
1008				else if (w) {
(gdb)
1003				if (*p == Inpar)

I seem to recall someone saying prompt truncation hasn't been looked
at yet, so sorry if you already know about it.

--
Mikael Magnusson