[for review] more changes to developer docs
Bert Thompson
aet at cs.mu.oz.au
Thu Apr 3 15:51:02 AEST 1997
Anyone,
Please review this change.
Muchas gracias...
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Estimated hours taken: 0.1
We now have HTML versions of all the developer docs from the
mercury/compiler/notes directory. Plain text equivalents are now
also generated.
Hence we add links to these documents from documentation.html.
developer/documentation.html
CVS: ----------------------------------------------------------------------
CVS: Enter Log. Lines beginning with `CVS: ' are removed automatically
CVS:
CVS: Modified Files:
CVS: documentation.html
CVS: ----------------------------------------------------------------------
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Index: documentation.html
===================================================================
RCS file: /home/staff/zs/imp/www/developer/documentation.html,v
retrieving revision 1.2
diff -c -r1.2 documentation.html
*** 1.2 1997/04/02 09:33:02
--- documentation.html 1997/04/03 05:38:18
***************
*** 27,33 ****
Outlines reviewing procedure. <p>
Available in
! <a href="REVIEWS.html">HTML</a> and <a href="REVIEWS">Plain text</a>
<p>
<li> <strong>Mercury Coding Standards</strong> <br>
--- 27,34 ----
Outlines reviewing procedure. <p>
Available in
! <a href="REVIEWS.html">HTML</a> and
! <a href="REVIEWS.text">Plain text</a>
<p>
<li> <strong>Mercury Coding Standards</strong> <br>
***************
*** 35,41 ****
Available in
<a href="CODING_STANDARDS.html">HTML</a> and
! <a href="CODING_STANDARDS">Plain text</a>
<p>
<li> <strong>Compiler Design</strong> <br>
--- 36,42 ----
Available in
<a href="CODING_STANDARDS.html">HTML</a> and
! <a href="CODING_STANDARDS.text">Plain text</a>
<p>
<li> <strong>Compiler Design</strong> <br>
***************
*** 42,48 ****
Details of the compiler design. <p>
Available in
! <a href="COMPILER_DESIGN">Plain text</a>
<p>
<li> <strong>Allocation</strong> <br>
--- 43,50 ----
Details of the compiler design. <p>
Available in
! <a href="COMPILER_DESIGN.html">HTML</a> and
! <a href="COMPILER_DESIGN.text">Plain text</a>
<p>
<li> <strong>Allocation</strong> <br>
***************
*** 49,55 ****
Details of the allocation scheme currently being implemented. <p>
Available in
! <a href="ALLOCATION">Plain text</a>
<p>
<li> <strong>Module system</strong> <br>
--- 51,58 ----
Details of the allocation scheme currently being implemented. <p>
Available in
! <a href="ALLOCATION.html">HTML</a> and
! <a href="ALLOCATION.text">Plain text</a>
<p>
<li> <strong>Module system</strong> <br>
***************
*** 56,62 ****
Details of the module system. <p>
Available in
! <a href="MODULE_SYSTEM">Plain text</a>
<p>
<li> <strong>Release checklist</strong> <br>
--- 59,66 ----
Details of the module system. <p>
Available in
! <a href="MODULE_SYSTEM.html">HTML</a> and
! <a href="MODULE_SYSTEM.text">Plain text</a>
<p>
<li> <strong>Release checklist</strong> <br>
***************
*** 63,69 ****
The release procedure. <p>
Available in
! <a href="RELEASE_CHECKLIST">Plain text</a>
<p>
<li> <strong>Garbage collection and C code</strong> <br>
--- 67,74 ----
The release procedure. <p>
Available in
! <a href="RELEASE_CHECKLIST.html">HTML</a> and
! <a href="RELEASE_CHECKLIST.text">Plain text</a>
<p>
<li> <strong>Garbage collection and C code</strong> <br>
***************
*** 70,76 ****
<p>
Available in
! <a href="GC_AND_C_CODE">Plain text</a>
<p>
<li> <strong>Glossary</strong> <br>
--- 75,82 ----
<p>
Available in
! <a href="GC_AND_C_CODE.html">HTML</a> and
! <a href="GC_AND_C_CODE.text">Plain text</a>
<p>
<li> <strong>Glossary</strong> <br>
***************
*** 77,83 ****
Terms used in the Mercury implementation. <p>
Available in
! <a href="GLOSSARY">Plain text</a>
<p>
<li> <strong>To do list</strong> <br>
--- 83,90 ----
Terms used in the Mercury implementation. <p>
Available in
! <a href="GLOSSARY.html">HTML</a> and
! <a href="GLOSSARY.text">Plain text</a>
<p>
<li> <strong>To do list</strong> <br>
***************
*** 84,90 ****
Things still to do in the Mercury project. <p>
Available in
! <a href="TODO">Plain text</a>
<p>
</ul>
--- 91,98 ----
Things still to do in the Mercury project. <p>
Available in
! <a href="TODO.html">HTML</a> and
! <a href="TODO.text">Plain text</a>
<p>
</ul>
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Estimated hours taken: 0.2
Added target for creating plain text equivalents of the HTML documents.
We use the file extension .text for the plain text documents.
All these docs are installed on the web pages.
Also added a target to clean away the generated plain text files.
mercury/compiler/notes/Mmakefile:
CVS: ----------------------------------------------------------------------
CVS: Enter Log. Lines beginning with `CVS: ' are removed automatically
CVS:
CVS: Committing in .
CVS:
CVS: Modified Files:
CVS: Mmakefile
CVS: ----------------------------------------------------------------------
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Index: Mmakefile
===================================================================
RCS file: /home/staff/zs/imp/mercury/compiler/notes/Mmakefile,v
retrieving revision 1.3
diff -c -r1.3 Mmakefile
*** 1.3 1997/04/03 05:17:41
--- Mmakefile 1997/04/03 05:34:38
***************
*** 13,23 ****
INSTALL_WEB_SUBDIR=$(INSTALL_WEBDIR)/developer
! #DOCS_TEXT=ALLOCATION AUTHORS CODING_STANDARDS COMPILER_DESIGN \
! # GC_AND_C_CODE GLOSSARY MODULE_SYSTEM RELEASE_CHECKLIST \
! # REVIEWS TODO
! DOCS_TEXT=
! DOC_HTML=ALLOCATION.html AUTHORS.html CODING_STANDARDS.html \
COMPILER_DESIGN.html GC_AND_C_CODE.html GLOSSARY.html \
MODULE_SYSTEM.html RELEASE_CHECKLIST.html REVIEWS.html TODO.html
DOCS_ALL=$(DOCS_TEXT) $(DOCS_HTML)
--- 13,33 ----
INSTALL_WEB_SUBDIR=$(INSTALL_WEBDIR)/developer
! HTML_TO_TEXT=lynx -dump
!
! #-----------------------------------------------------------------------------#
!
! .SUFFIXES: .html .text
!
! .html.text:
! $(HTML_TO_TEXT) $< > $@
!
! #-----------------------------------------------------------------------------#
!
! DOCS_TEXT=ALLOCATION.text AUTHORS.text CODING_STANDARDS.text \
! COMPILER_DESIGN.text GC_AND_C_CODE.text GLOSSARY.text \
! MODULE_SYSTEM.text RELEASE_CHECKLIST.text REVIEWS.text TODO.text
! DOCS_HTML=ALLOCATION.html AUTHORS.html CODING_STANDARDS.html \
COMPILER_DESIGN.html GC_AND_C_CODE.html GLOSSARY.html \
MODULE_SYSTEM.html RELEASE_CHECKLIST.html REVIEWS.html TODO.html
DOCS_ALL=$(DOCS_TEXT) $(DOCS_HTML)
***************
*** 33,36 ****
--- 43,49 ----
[ -d $(INSTALL_WEB_SUBDIR) ] || mkdir -p $(INSTALL_WEB_SUBDIR)
cp $(DOCS_ALL) $(INSTALL_WEB_SUBDIR)
+ clean:
+ rm -f $(DOCS_TEXT)
+
#-----------------------------------------------------------------------------#
More information about the developers
mailing list