[m-dev.] for review: use makeinfo instead of texi2html
Fergus Henderson
fjh at cs.mu.OZ.AU
Tue Jul 22 18:33:18 AEST 2003
Estimated hours taken: 3
Branches: main
doc/Mmakefile:
Use `makeinfo --html' rather than `perl texi2html' for creating
the HTML version of the documentation. Since makeinfo outputs
the HTML to different file names than texi2html, this also required
various other changes to handle the different file names.
doc/faq.texi:
doc/library.texi:
doc/reference_manual.texi:
doc/transition_guide.texi:
doc/user_guide.texi:
Change @ifinfo to @ifnottex.
Uncomment the @dircategory commands, which were previously commented
out because they weren't supported by (our old version of) texi2html.
Update copyright dates.
Workspace: /home/ceres/fjh/mercury
Index: doc/Mmakefile
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/Mmakefile,v
retrieving revision 1.34
diff -u -d -r1.34 Mmakefile
--- doc/Mmakefile 24 Jan 2003 07:17:09 -0000 1.34
+++ doc/Mmakefile 22 Jul 2003 08:20:30 -0000
@@ -31,10 +31,10 @@
# The following variables specify which programs should be used to
# to format the documentation.
-TEXI2HTML=$(PERL) texi2html
-TEXI2HTML_SPLIT=$(PERL) texi2html -split
+TEXI2HTML=$(MAKEINFO) --html --number-sections --no-split
+TEXI2HTML_SPLIT=$(MAKEINFO) --html --number-sections
-ifeq ("$(PERL)","")
+ifeq ("$(MAKEINFO)","")
HTML=warn_no_html
else
HTML=html
@@ -77,12 +77,6 @@
%.text: %.texi_pp
$(MAKEINFO) --no-headers -o $@ $<
-%.html %_toc.html: %.texi_pp
- $(TEXI2HTML) $<
-
-%_1.html: %.texi_pp
- $(TEXI2HTML_SPLIT) $<
-
M_ENV = \
MERCURY_PROFILER=../profiler/mercury_profile \
MERCURY_COMPILER=../compiler/mercury_compile \
@@ -139,7 +133,7 @@
# This is probably due to a missing `makeinfo'
.PHONY: html
-html: mercury.html $(TEXINFO_FILES:%=%_toc.html)
+html: mercury.html $(TEXINFO_INFO_FILES:%.info=%.html)
.PHONY: warn_no_html
warn_no_html:
@@ -158,7 +152,7 @@
text: $(TEXINFO_FILES:%=%.text)
.PHONY: split_html
-split_html: mercury.html $(TEXINFO_FILES:%=%_1.html)
+split_html: mercury.html $(TEXINFO_INFO_FILES:%.info=%/index.html)
.PHONY: manpages
manpages: $(MANPAGE_PROGS:%=%.1)
@@ -182,6 +176,28 @@
mercury_library.info: library.texi_pp
$(MAKEINFO) $<
+mercury_user_guide.html: user_guide.texi_pp
+ $(TEXI2HTML) $<
+mercury_ref.html: reference_manual.texi_pp
+ $(TEXI2HTML) $<
+mercury_trans_guide.html: transition_guide.texi_pp
+ $(TEXI2HTML) $<
+mercury_faq.html: faq.texi_pp
+ $(TEXI2HTML) $<
+mercury_library.html: library.texi_pp
+ $(TEXI2HTML) $<
+
+mercury_user_guide/index.html: user_guide.texi_pp
+ $(TEXI2HTML_SPLIT) $<
+mercury_ref/index.html: reference_manual.texi_pp
+ $(TEXI2HTML_SPLIT) $<
+mercury_trans_guide/index.html: transition_guide.texi_pp
+ $(TEXI2HTML_SPLIT) $<
+mercury_faq/index.html: faq.texi_pp
+ $(TEXI2HTML_SPLIT) $<
+mercury_library/index.html: library.texi_pp
+ $(TEXI2HTML_SPLIT) $<
+
#-----------------------------------------------------------------------------#
.PHONY: warn_no_mdb_doc
@@ -352,7 +368,7 @@
for file in $(INSTALL_WEBPAGE_DIR)/*.ps ; do \
gzip -f -9 $$file ; \
done
- cp *.html $(INSTALL_WEBPAGE_DIR)
+ cp -r $(TEXINFO_INFO_FILES:%.info=%) $(INSTALL_WEBPAGE_DIR)
#-----------------------------------------------------------------------------#
Index: doc/faq.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/faq.texi,v
retrieving revision 1.26
diff -u -d -r1.26 faq.texi
--- doc/faq.texi 5 Aug 2002 04:01:57 -0000 1.26
+++ doc/faq.texi 22 Jul 2003 08:26:04 -0000
@@ -2,11 +2,10 @@
@setfilename mercury_faq.info
@settitle The Mercury FAQ list
- at c --- texi2html doesn't support the @dir commands yet
- at c @dircategory The Mercury Programming Language
- at c @direntry
- at c * Mercury FAQ: (mercury_faq). The Mercury Frequently Asked Questions list.
- at c @end direntry
+ at dircategory The Mercury Programming Language
+ at direntry
+* Mercury FAQ: (mercury_faq). The Mercury Frequently Asked Questions list.
+ at end direntry
@c failed attempt to control spacing
@c @tex
@@ -21,11 +20,11 @@
@c @cropmarks
@finalout
@setchapternewpage off
- at ifinfo
+ at ifnottex
This file is the Mercury Frequently Asked Questions List, version <VERSION>.
It contains a list of frequently asked questions about Mercury, with answers.
-Copyright (C) 1995-1997,1999,2001-2002 The University of Melbourne.
+Copyright (C) 1995-1997,1999,2001-2003 The University of Melbourne.
Permission is granted to make and distribute verbatim copies of
this FAQ list provided the copyright notice and this permission notice
@@ -45,7 +44,7 @@
Permission is granted to copy and distribute translations of this FAQ list
into another language, under the above conditions for modified versions.
- at end ifinfo
+ at end ifnottex
@titlepage
@title The Mercury Frequently Asked Questions List
@@ -72,7 +71,7 @@
@page
@contents
- at ifinfo
+ at ifnottex
@node Top,,, (mercury)
@top The Mercury Frequently Asked Questions List, version <VERSION>
@menu
@@ -80,7 +79,7 @@
* Unimplemented:: Problems caused by unimplemented Mercury features.
* Last resort:: What to do when all else fails.
@end menu
- at end ifinfo
+ at end ifnottex
@node Programming
@chapter Common programming errors
Index: doc/library.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/library.texi,v
retrieving revision 1.19
diff -u -d -r1.19 library.texi
--- doc/library.texi 5 Aug 2002 04:01:57 -0000 1.19
+++ doc/library.texi 22 Jul 2003 08:26:12 -0000
@@ -2,20 +2,19 @@
@setfilename mercury_library.info
@settitle The Mercury Library Reference Manual
- at c --- texi2html doesn't support the @dir commands yet
- at c @dircategory The Mercury Programming Language
- at c @direntry
- at c * Mercury Library: (mercury_library). The Mercury Library Reference Manual.
- at c @end direntry
+ at dircategory The Mercury Programming Language
+ at direntry
+* Mercury Library: (mercury_library). The Mercury Library Reference Manual.
+ at end direntry
@c @smallbook
@c @cropmarks
@finalout
@setchapternewpage off
- at ifinfo
+ at ifnottex
This file documents the Mercury standard library, version <VERSION>.
-Copyright (C) 1995-1997,1999-2002 The University of Melbourne.
+Copyright (C) 1995-1997,1999-2003 The University of Melbourne.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -35,7 +34,7 @@
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
- at end ifinfo
+ at end ifnottex
@titlepage
@title The Mercury Library Reference Manual
@@ -63,10 +62,10 @@
@page
@c ---------------------------------------------------------------------------
- at ifinfo
+ at ifnottex
@node Top,,, (mercury)
@top Mercury Library Reference Manual, version <VERSION>
- at end ifinfo
+ at end ifnottex
The Mercury standard library contains a variety of modules which we
hope may be of general usefulness. If you write a module that would
Index: doc/reference_manual.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/reference_manual.texi,v
retrieving revision 1.276
diff -u -d -r1.276 reference_manual.texi
--- doc/reference_manual.texi 25 Jun 2003 06:57:34 -0000 1.276
+++ doc/reference_manual.texi 22 Jul 2003 08:12:33 -0000
@@ -2,11 +2,10 @@
@setfilename mercury_ref.info
@settitle The Mercury Language Reference Manual
- at c --- texi2html doesn't support the @dir commands yet
- at c @dircategory The Mercury Programming Language
- at c @direntry
- at c * Mercury Language: (mercury_ref). The Mercury Language Reference Manual.
- at c @end direntry
+ at dircategory The Mercury Programming Language
+ at direntry
+* Mercury Language: (mercury_ref). The Mercury Language Reference Manual.
+ at end direntry
@c Uncomment the line below to enable documentation of the Aditi interface.
@set aditi
@@ -15,7 +14,7 @@
@c @cropmarks
@finalout
@setchapternewpage off
- at ifinfo
+ at ifnottex
This file documents the Mercury programming language, version <VERSION>.
Copyright (C) 1995-2003 The University of Melbourne.
@@ -38,7 +37,7 @@
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
- at end ifinfo
+ at end ifnottex
@titlepage
@title The Mercury Language Reference Manual
@@ -54,7 +53,7 @@
@author Ralph Becket
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1995--2002 The University of Melbourne.
+Copyright @copyright{} 1995--2003 The University of Melbourne.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -72,10 +71,10 @@
@page
@c ---------------------------------------------------------------------------
- at ifinfo
+ at ifnottex
@node Top,,, (mercury)
@top The Mercury Language Reference Manual, version <VERSION>
- at end ifinfo
+ at end ifnottex
@c XXX Move to after Determinism
@c * Assertions:: Assertion declarations allow you to declare laws
@c that hold.
@@ -7068,8 +7067,8 @@
pointers to memory on the Mercury heap after Mercury has backtracked
to before the point where that memory was allocated.
You must also avoid the use of the macros
- at code{list_empty()} and @code{list_cons()}.
-(The reason for this is that they may access Mercury's @samp{hp} register,
+ at code{MR_list_empty()} and @code{MR_list_cons()}.
+(The reason for this is that they may access Mercury's @samp{MR_hp} register,
which might not be valid in C code. Using them in the bodies of
procedures defined using @samp{pragma c_code} with
@samp{will_not_call_mercury} would probably work, but we don't advise it.)
Index: doc/transition_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/transition_guide.texi,v
retrieving revision 1.41
diff -u -d -r1.41 transition_guide.texi
--- doc/transition_guide.texi 5 Aug 2002 04:02:00 -0000 1.41
+++ doc/transition_guide.texi 22 Jul 2003 08:26:18 -0000
@@ -2,20 +2,19 @@
@setfilename mercury_trans_guide.info
@settitle The Prolog to Mercury transition guide
- at c --- texi2html doesn't support the @dir commands yet
- at c @dircategory The Mercury Programming Language
- at c @direntry
- at c * Mercury Transition Guide: (mercury_trans_guide). The Prolog to Mercury Transition Guide.
- at c @end direntry
+ at dircategory The Mercury Programming Language
+ at direntry
+* Mercury Transition Guide: (mercury_trans_guide). The Prolog to Mercury Transition Guide.
+ at end direntry
@c @smallbook
@c @cropmarks
@finalout
@setchapternewpage off
- at ifinfo
+ at ifnottex
This file is an aid for people porting Prolog programs to Mercury.
-Copyright (C) 1995-2002 The University of Melbourne.
+Copyright (C) 1995-2003 The University of Melbourne.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -35,7 +34,7 @@
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
- at end ifinfo
+ at end ifnottex
@titlepage
@title The Prolog to Mercury transition guide
@@ -45,7 +44,7 @@
@author Fergus Henderson
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1995--2002 The University of Melbourne.
+Copyright @copyright{} 1995--2003 The University of Melbourne.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -62,7 +61,7 @@
@contents
@page
- at ifinfo
+ at ifnottex
@node Top,,, (mercury)
@top The Prolog to Mercury Transition Guide, version <VERSION>
@@ -80,7 +79,7 @@
* All-solutions:: All-solutions predicates: @code{findall} and @code{setof}.
@c * Problems:: Common Problems.
@end menu
- at end ifinfo
+ at end ifnottex
@node Introduction
@chapter Introduction
Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.370
diff -u -d -r1.370 user_guide.texi
--- doc/user_guide.texi 14 May 2003 04:05:44 -0000 1.370
+++ doc/user_guide.texi 22 Jul 2003 08:26:24 -0000
@@ -2,11 +2,10 @@
@setfilename mercury_user_guide.info
@settitle The Mercury User's Guide
- at c --- texi2html doesn't support the @dir commands yet
- at c @dircategory The Mercury Programming Language
- at c @direntry
- at c * Mercury User's Guide: (mercury_user_guide). The Mercury User's Guide.
- at c @end direntry
+ at dircategory The Mercury Programming Language
+ at direntry
+* Mercury User's Guide: (mercury_user_guide). The Mercury User's Guide.
+ at end direntry
@c Uncomment the line below to enable documentation of the Aditi interface.
@set aditi
@@ -42,7 +41,7 @@
@c ----------------------------------------------------------------------------
- at ifinfo
+ at ifnottex
This file documents the Mercury implementation, version <VERSION>.
Copyright (C) 1995-2003 The University of Melbourne.
@@ -65,7 +64,7 @@
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
- at end ifinfo
+ at end ifnottex
@titlepage
@title The Mercury User's Guide
@@ -78,7 +77,7 @@
@author Mark Brown
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1995--2002 The University of Melbourne.
+Copyright @copyright{} 1995--2003 The University of Melbourne.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -100,7 +99,7 @@
@c ----------------------------------------------------------------------------
- at ifinfo
+ at ifnottex
@node Top,,, (mercury)
@top The Mercury User's Guide, version <VERSION>
@@ -125,7 +124,7 @@
languages from Mercury.
* Index::
@end menu
- at end ifinfo
+ at end ifnottex
@c ----------------------------------------------------------------------------
--
Fergus Henderson <fjh at cs.mu.oz.au> | "I have always known that the pursuit
The University of Melbourne | of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh> | -- the last words of T. S. Garp.
--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to: mercury-developers at cs.mu.oz.au
Administrative Queries: owner-mercury-developers at cs.mu.oz.au
Subscriptions: mercury-developers-request at cs.mu.oz.au
--------------------------------------------------------------------------
More information about the developers
mailing list