m4-patches
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: documentation error in m4 online help


From: Eric Blake
Subject: Re: documentation error in m4 online help
Date: Tue, 23 May 2006 18:40:44 -0600
User-agent: Thunderbird 1.5.0.2 (Windows/20060308)

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

According to Bob Badour on 5/20/2006 12:45 PM:
>> I don't think the m4 manual really needs to do anything at this point,
>> unless you folks feel like going to the extraordinary measure of
>> postprocessing the HTML output with a sed/perl/whatever script to fix
>> the href.
>>
>> Best,
>> Karl (Texinfo maintainer, supposedly :)

> You might be able to stick with a relative URL if you use:
> 
> "../../emacs/manual/emacs.html#Regexps"

It's not that simple - both the html and the info manual are generated
from the same source, which previously had no URL, and it would be nicer
if the html version could link to a user's local html installation if one
exists rather than always having a URL to the web.  But I tested the
following patch, which at least gives a non-broken link (and makes it
easier to generate the html manual in the 1.4.x series):

2006-05-23  Eric Blake  <address@hidden>

        * Makefile.in (html): New target.
        * doc/Makefile.in (html, m4.html): Likewise.
        (MAKEINFOHTML): New macro.
        * doc/m4.texinfo (Francois) [ifnottex]: Use newer texinfo
        rendering.
        (Regexp) [ifhtml]: Make cross-reference to emacs manual an
        absolute URL.
        Reported by Bob Badour.

Any reason I should not apply it?

- --
Life is short - so eat dessert first!

Eric Blake             address@hidden
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.1 (Cygwin)
Comment: Public key at home.comcast.net/~ericblake/eblake.gpg
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFEc6uL84KuGfSFAYARAqeMAJ9vKWtVu04K9nP8873Dj8Z9oBwuHACdFvLW
U6wIz+TcWmd+JSUOxyCRmNU=
=R2DT
-----END PGP SIGNATURE-----
Index: Makefile.in
===================================================================
RCS file: /sources/m4/m4/Attic/Makefile.in,v
retrieving revision 1.1.1.1.2.8
diff -u -p -r1.1.1.1.2.8 Makefile.in
--- Makefile.in 11 May 2006 13:10:48 -0000      1.1.1.1.2.8
+++ Makefile.in 24 May 2006 00:37:24 -0000
@@ -64,7 +64,7 @@ all install uninstall: config.h
          (cd $$subdir && $(MAKE) $(MDEFINES) $@) || exit 1; \
        done
 
-info dvi:
+info dvi html:
        cd doc && $(MAKE) $@
 
 check: all
Index: doc/Makefile.in
===================================================================
RCS file: /sources/m4/m4/doc/Attic/Makefile.in,v
retrieving revision 1.1.1.1.2.7
diff -u -p -r1.1.1.1.2.7 Makefile.in
--- doc/Makefile.in     11 May 2006 12:17:45 -0000      1.1.1.1.2.7
+++ doc/Makefile.in     24 May 2006 00:37:24 -0000
@@ -27,6 +27,7 @@ VPATH = @srcdir@
 INSTALL = @INSTALL@
 INSTALL_DATA = @INSTALL_DATA@
 MAKEINFO = makeinfo
+MAKEINFOHTML = $(MAKEINFO) --html
 TEXI2DVI = texi2dvi
 
 prefix = @prefix@
@@ -52,6 +53,22 @@ dvi: m4.dvi
 m4.dvi: m4.texinfo version.texi
        $(TEXI2DVI) $(srcdir)/m4.texinfo
 
+html: m4.html
+
+m4.html: m4.texinfo version.texi
+       rm -rf $(@:.html=.htp)
+       if $(MAKEINFOHTML) $(MAKEINFOFLAGS) -I doc -I $(srcdir)/doc \
+        -o $(@:.html=.htp) `test -f 'm4.texinfo' || echo 
'$(srcdir)/'`m4.texinfo; \
+       then \
+         rm -rf $@; \
+         if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \
+           mv $(@:.html=) $@; else mv $(@:.html=.htp) $@; fi; \
+       else \
+         if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \
+           rm -rf $(@:.html=); else rm -Rf $(@:.html=.htp) $@; fi; \
+         exit 1; \
+       fi
+
 version.texi: stamp-vti
 stamp-vti: m4.texinfo ../configure.ac
        echo "@set EDITION $(VERSION)" > version.tmp
Index: doc/m4.texinfo
===================================================================
RCS file: /sources/m4/m4/doc/m4.texinfo,v
retrieving revision 1.1.1.1.2.8
diff -u -p -r1.1.1.1.2.8 m4.texinfo
--- doc/m4.texinfo      11 May 2006 13:27:57 -0000      1.1.1.1.2.8
+++ doc/m4.texinfo      24 May 2006 00:37:24 -0000
@@ -9,9 +9,9 @@
 
 @include version.texi
 
address@hidden
address@hidden Francois Franc,ois
address@hidden ifinfo
address@hidden
address@hidden Francois Fran@,{c}ois
address@hidden ifnottex
 @tex
 @set Francois Fran\noexpand\ptexc cois
 @end tex
@@ -2466,8 +2466,16 @@ regexp(@var{string}, @var{regexp}, opt @
 
 @noindent
 which searches for @var{regexp} in @var{string}.  The syntax for regular
-expressions is the same as in GNU Emacs.  @xref{Regexps, , Syntax of
-Regular Expressions, emacs, The GNU Emacs Manual}.
+expressions is the same as in GNU Emacs.
address@hidden
address@hidden, , Syntax of Regular Expressions, emacs, The GNU Emacs
+Manual}.
address@hidden ifnothtml
address@hidden
+See
address@hidden://www.gnu.org/@/software/@/emacs/@/manual/@/emacs.html#Regexps,
+Syntax of Regular Expressions} in the GNU Emacs Manual.
address@hidden ifhtml
 
 If @var{replacement} is omitted, @code{regexp} expands to the index of
 the first match of @var{regexp} in @var{string}.  If @var{regexp} does

reply via email to

[Prev in Thread] Current Thread [Next in Thread]