Re: documentation update

[Peter Stephenson <p.w.stephenson@xxxxxxxxxxxx>]

Wayne Davison wrote:
> On Fri, Mar 17, 2006 at 07:52:55PM +0000, Peter Stephenson wrote:
> > Also, if you diff the manual page output, you'll see that (real) 's are
> > being quoted as \&': again, I presume this is a feature.
> 
> Unfortnately, that's a misfeature.  That makes an apostrophe output as a
> curly quote, and that ruins things like example code where an apostrophe
> is what you really must type.  This sounds like something where a change
> from the various packagers (e.g. Debian) didn't bubble up to affect the
> new yodl version (since this misfeature was never actually fixed in the
> distributed yodl code itself, but was only patched in lower down).

OK, it could probably be added to your existing fix from August:

	    $(YODL) -I$(sdir) -w zman.yo version.yo $< | \
	      sed -e '1s/\\-/-/g' -e '/^\.'\''/d' \
	      -e 's/\(\\fB\)*'\''/\1\\\&'\''/' > $$target \

although it might be nicer if the quotes were only made literal in
examples; I wonder if we can tag them in such a way that sed or possibly
awk can recognize the hunks?

Also, version.yo is auto-generated, so that needs a change in the
Makefile:

Index: Doc/Makefile.in
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Makefile.in,v
retrieving revision 1.30
diff -u -r1.30 Makefile.in
--- Doc/Makefile.in	21 Oct 2005 09:51:55 -0000	1.30
+++ Doc/Makefile.in	17 Mar 2006 23:34:19 -0000
@@ -205,10 +205,10 @@
 
 version.yo: $(sdir_top)/Config/version.mk
 	( \
-	  echo 'STARTDEF()'; \
+	  echo 'IFDEF(INCWSLEVEL)(INCWSLEVEL())(STARTDEF())'; \
 	  echo 'def(version)(0)('$(VERSION)')'; \
 	  echo 'def(date)(0)('$(VERSION_DATE)')'; \
-	  echo 'ENDDEF()#' | tr '#' '\\'; \
+	  echo 'IFDEF(DECWSLEVEL)(DECWSLEVEL())(ENDDEF())#' | tr '#' '\\'; \
 	) > $(sdir)/version.yo
 
 Zsh/modlist.yo: $(MODDOCSRC)

-- 
Peter Stephenson <p.w.stephenson@xxxxxxxxxxxx>
Web page still at http://www.pwstephenson.fsnet.co.uk/