Manual: Today's Patch
Jeffrey D . Oldham
oldham at codesourcery.com
Wed Jan 30 23:13:24 UTC 2002
The POOMA manual must be delivered tomorrow. The formatting changes
continue, but the volume decreases.
2002-Jan-30 Jeffrey D. Oldham <oldham at codesourcery.com>
* Makefile: Clean to convert from a general Makefile to one for
creating the POOMA manual.
* arrays.xml: Revise tags to ones that are implemented by DocBook.
* concepts.xml: Revise figures to support PostScript and HTML/PDF.
* data-parallel.xml: Likewise.
* introduction.xml: Likewise.
* manual.xml: Remove FIXME comment.
* template.xml: Shorten section titles. Reformat type.
* tutorial.xml: Revise figures to support PostScript and HTML/PDF.
Applied to mainline
Approved by Jeff Brown.
Thanks,
Jeffrey D. Oldham
oldham at codesourcery.com
-------------- next part --------------
Index: Makefile
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/Makefile,v
retrieving revision 1.2
diff -c -p -r1.2 Makefile
*** Makefile 2002/01/25 02:28:25 1.2
--- Makefile 2002/01/30 22:59:22
***************
*** 1,74 ****
### Oldham, Jeffrey D.
! ### 1997 Dec 26
! ### misc
###
! ### LaTeX -> PostScript/PDF/WWW
! ### XML -> TeX/DVI/PS/PDF
- # Definitions for PostScript and WWW Creation
TEX= latex
- WWWHOMEDIR= /u/oldham/www
- LATEX2HTML= latex2html
- BASICLATEX2HTMLOPTIONS= -info "" -no_footnode -no_math -html_version 3.2,math
- #LATEX2HTMLOPTIONS= -local_icons -split +1 $(BASICLATEX2HTMLOPTIONS)
- LATEX2HTMLOPTIONS= -no_navigation -split 0 $(BASICLATEX2HTMLOPTIONS)
- MPOST= mpost
# Definitions for Jade.
JADEDIR= /usr/lib/sgml/stylesheets/docbook
! PRINTDOCBOOKDSL= print/docbook.dsl
! HTMLDOCBOOKDSL= html/docbook.dsl
XML= dtds/decls/xml.dcl
INDEXOPTIONS= -t 'Index' -i 'index' -g -p
! CXXFLAGS= -g -Wall -pedantic -W -Wstrict-prototypes -Wpointer-arith -Wbad-function-cast -Wcast-align -Wconversion -Wnested-externs -Wundef -Winline -static
! all: manual.ps
! manual.dvi: manual.xml introduction.xml template.xml tutorial.xml \
! concepts.xml arrays.xml data-parallel.xml glossary.xml \
! bibliography.xml
! %.all: %.ps %.pdf %.html
! chmod 644 $*.ps $*.pdf
! mv $*.ps $*.pdf $*
!
! %.dvi: %.ltx
! $(TEX) $<
! # bibtex $*
! # $(TEX) $<
! $(TEX) $<
!
! %.ps: %.dvi
! dvips -t letter $< -o
!
! %.pdf.ltx: %.ltx
! sed -e 's/^%\\usepackage{times}/\\usepackage{times}/' $< > $@
!
! %.pdf: %.pdf.ltx
! pdflatex $<
! mv $@.pdf $@
! # This rule assumes index creation.
! %.dvi: %.xml genindex.sgm
! jade -D$(JADEDIR) -t sgml -d $(HTMLDOCBOOKDSL) -V html-index $(XML) $< && \
! perl collateindex.pl $(INDEXOPTIONS) -o genindex.sgm HTML.index && \
! jade -D$(JADEDIR) -t tex -d $(PRINTDOCBOOKDSL) -V tex-backend $(XML) $< && jadetex $*.tex && jadetex $*.tex && jadetex $*.tex
genindex.sgm:
perl collateindex.pl $(INDEXOPTIONS) -N -o $@
! %.html: %.xml
jade -D$(JADEDIR) -t sgml -d $(HTMLDOCBOOKDSL) $(XML) $<
! %.pdf: %.xml
! jade -D$(JADEDIR) -t tex -d $(PRINTDOCBOOKDSL) $(XML) $< && pdfjadetex $*.tex && pdfjadetex $*.tex
!
! mproof-%.ps: %.mp
! declare -x TEX=latex && $(MPOST) $< && tex mproof.tex $*.[0-9]* && dvips mproof.dvi -o $@
! %.txt: %.ltx
! detex $< > $@
clean:
! rm -f *.dvi *.aux *.log *.toc *.bak *.blg *.bbl *.glo *.idx *.lof *.lot *.htm *.mpx mpxerr.tex HTML.index manual.tex genindex.sgm
--- 1,54 ----
### Oldham, Jeffrey D.
! ### 2002Jan29
! ### POOMA
###
! ### POOMA Manual Creation
TEX= latex
# Definitions for Jade.
JADEDIR= /usr/lib/sgml/stylesheets/docbook
! PRINTDOCBOOKDSL= print.dsl # print/docbook.dsl
! HTMLDOCBOOKDSL= html.dsl # html/docbook.dsl
XML= dtds/decls/xml.dcl
INDEXOPTIONS= -t 'Index' -i 'index' -g -p
! XMLSOURCES= manual.xml introduction.xml template.xml tutorial.xml \
! concepts.xml arrays.xml data-parallel.xml glossary.xml \
! bibliography.xml
! ## HERE How do I include dependences on programs?
! all: manual.ps manual.pdf manual.html
! manual.dvi manual.pdf manual.html: $(XMLSOURCES) figures
! figures:
! $(MAKE) -C figures
genindex.sgm:
perl collateindex.pl $(INDEXOPTIONS) -N -o $@
! %.html: %.xml html.dsl
jade -D$(JADEDIR) -t sgml -d $(HTMLDOCBOOKDSL) $(XML) $<
! # This rule assumes index creation.
! %.dvi: %.xml genindex.sgm print.dsl
! jade -D$(JADEDIR) -t sgml -d $(HTMLDOCBOOKDSL) -V html-index $(XML) $<
! perl collateindex.pl $(INDEXOPTIONS) -o genindex.sgm HTML.index
! jade -D$(JADEDIR) -t tex -d $(PRINTDOCBOOKDSL) -V tex-backend -V use-eps $(XML) $<
! jadetex $*.tex
! jadetex $*.tex
! jadetex $*.tex
! # This rule assumes index creation.
! %.pdf: %.xml genindex.sgm print.dsl
! jade -D$(JADEDIR) -t sgml -d $(HTMLDOCBOOKDSL) -V html-index $(XML) $<
! perl collateindex.pl $(INDEXOPTIONS) -o genindex.sgm HTML.index
! jade -D$(JADEDIR) -t tex -d $(PRINTDOCBOOKDSL) $(XML) $<
! pdfjadetex $*.tex
! pdfjadetex $*.tex
! pdfjadetex $*.tex
clean:
! rm -f *.dvi *.aux *.log *.toc *.bak *.blg *.bbl *.glo *.idx *.lof *.lot *.htm *.html *.mpx mpxerr.tex HTML.index manual.tex genindex.sgm pooma-html.manifest
Index: arrays.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/arrays.xml,v
retrieving revision 1.5
diff -c -p -r1.5 arrays.xml
*** arrays.xml 2002/01/29 21:45:42 1.5
--- arrays.xml 2002/01/30 22:59:23
*************** std::cout &openopen; a.read(2,-2) &openo
*** 1644,1651 ****
domain index to a particular processor and memory used to compute
the associated value.<!-- FIXME: Add a reference to the
corresponding chapter. --> The two internal enumerations
! <fieldsynopsis><varname>dimensions</varname></fieldsynopsis> and
! <fieldsynopsis><varname>rank</varname></fieldsynopsis> both record
the &array;'s dimension.</para>
<table frame="none" colsep="0" rowsep="0" tocentry="1"
--- 1644,1651 ----
domain index to a particular processor and memory used to compute
the associated value.<!-- FIXME: Add a reference to the
corresponding chapter. --> The two internal enumerations
! <varname>dimensions</varname> and
! <varname>rank</varname> both record
the &array;'s dimension.</para>
<table frame="none" colsep="0" rowsep="0" tocentry="1"
Index: concepts.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/concepts.xml,v
retrieving revision 1.10
diff -c -p -r1.10 concepts.xml
*** concepts.xml 2002/01/29 21:45:42 1.10
--- concepts.xml 2002/01/30 22:59:24
***************
*** 330,335 ****
--- 330,338 ----
<imageobject>
<imagedata fileref="figures/concepts.111" format="EPS" align="center"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/concepts-111.png" format="PNG" align="center"></imagedata>
+ </imageobject>
<textobject>
<phrase>concepts involved in declaring containers</phrase>
</textobject>
***************
*** 355,360 ****
--- 358,366 ----
<mediaobject>
<imageobject>
<imagedata fileref="figures/concepts.101" format="EPS" align="center"></imagedata>
+ </imageobject>
+ <imageobject>
+ <imagedata fileref="figures/concepts-101.png" format="PNG" align="center"></imagedata>
</imageobject>
<textobject>
<phrase>&array;s and &field;s map from indices to values.</phrase>
Index: data-parallel.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/data-parallel.xml,v
retrieving revision 1.4
diff -c -p -r1.4 data-parallel.xml
*** data-parallel.xml 2002/01/29 21:45:42 1.4
--- data-parallel.xml 2002/01/30 22:59:25
*************** Array<2, double, Brick> A(I,I), B(J,H);
*** 123,128 ****
--- 123,131 ----
<imageobject>
<imagedata fileref="figures/data-parallel.212" format="EPS" align="center"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/data-parallel-212.png" format="PNG" align="center"></imagedata>
+ </imageobject>
<textobject>
<phrase>Adding two arrays with different domains adds values
with the same indices.</phrase>
*************** Expression<BinaryNode<OpAdd,
*** 985,990 ****
--- 988,996 ----
<mediaobject>
<imageobject>
<imagedata fileref="figures/data-parallel.101" format="EPS" align="center"></imagedata>
+ </imageobject>
+ <imageobject>
+ <imagedata fileref="figures/data-parallel-101.png" format="PNG" align="center"></imagedata>
</imageobject>
<textobject>
<phrase>A parse tree for the statement is produced.</phrase>
Index: introduction.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/introduction.xml,v
retrieving revision 1.5
diff -c -p -r1.5 introduction.xml
*** introduction.xml 2002/01/29 21:45:42 1.5
--- introduction.xml 2002/01/30 22:59:26
***************
*** 126,131 ****
--- 126,134 ----
<imageobject>
<imagedata fileref="figures/introduction.101" format="EPS" align="center"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/introduction-101.png" format="PNG" align="center"></imagedata>
+ </imageobject>
<textobject>
<phrase>&pooma; helps translate algorithms into programs.</phrase>
</textobject>
Index: manual.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/manual.xml,v
retrieving revision 1.11
diff -c -p -r1.11 manual.xml
*** manual.xml 2002/01/29 21:45:42 1.11
--- manual.xml 2002/01/30 22:59:29
***************
*** 1,6 ****
<?xml version="1.0"?>
<!-- FIXME: Index this file. -->
- <!-- FIXME: What font does DocBook/JadeTeX use? Can we use it for the figures? -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "file:///usr/lib/sgml/docbookx.dtd" [
--- 1,5 ----
Index: template.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/template.xml,v
retrieving revision 1.3
diff -c -p -r1.3 template.xml
*** template.xml 2002/01/29 21:45:42 1.3
--- template.xml 2002/01/30 22:59:30
***************
*** 281,287 ****
orient="port" pgwide="0"
id="template_programming-template_use-correspondence_table">
<title>Correspondences Between Run-Time and Compile-Time
! Programming Constructs</title>
<tgroup cols="3" align="left">
<thead>
--- 281,287 ----
orient="port" pgwide="0"
id="template_programming-template_use-correspondence_table">
<title>Correspondences Between Run-Time and Compile-Time
! Constructs</title>
<tgroup cols="3" align="left">
<thead>
*************** typedef typename Engine_t::Domain_t Doma
*** 524,530 ****
orient="port" pgwide="0"
id="template_programming-pooma_implementation-correspondence_table">
<title>More Correspondences Between Run-Time and Compile-Time
! Programming Constructs</title>
<tgroup cols="3" align="left">
<thead>
--- 524,530 ----
orient="port" pgwide="0"
id="template_programming-pooma_implementation-correspondence_table">
<title>More Correspondences Between Run-Time and Compile-Time
! Constructs</title>
<tgroup cols="3" align="left">
<thead>
*************** struct CreateLeaf<Expression<T&clo
*** 943,949 ****
matches the condition is executed. If no case label matches the
condition, the default code, if present, is used. In template
programming, instantiating a template, e.g.,
! <type>CreateLeaf<Expression<int&closeclose;</type> serves as
the condition. The set of template parameters for the indicated
template class, e.g., <type>CreateLeaf</type>, are analogous to
the case labels, and each has an associated definition. In our
--- 943,951 ----
matches the condition is executed. If no case label matches the
condition, the default code, if present, is used. In template
programming, instantiating a template, e.g.,
! <programlisting>
! CreateLeaf<Expression<int&closeclose;
! </programlisting> serves as
the condition. The set of template parameters for the indicated
template class, e.g., <type>CreateLeaf</type>, are analogous to
the case labels, and each has an associated definition. In our
Index: tutorial.xml
===================================================================
RCS file: /home/pooma/Repository/r2/docs/manual/tutorial.xml,v
retrieving revision 1.8
diff -c -p -r1.8 tutorial.xml
*** tutorial.xml 2002/01/29 21:45:42 1.8
--- tutorial.xml 2002/01/30 22:59:31
***************
*** 69,74 ****
--- 69,77 ----
<imageobject>
<imagedata fileref="figures/doof2d.201" format="EPS" align="center"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/doof2d-201.png" format="PNG" align="center"></imagedata>
+ </imageobject>
<textobject>
<phrase>The Initial &doof2d; Configuration</phrase>
</textobject>
***************
*** 77,82 ****
--- 80,88 ----
<imageobject>
<imagedata fileref="figures/doof2d.202" format="EPS"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/doof2d-202.png" format="PNG"></imagedata>
+ </imageobject>
<textobject>
<phrase>After the First Averaging</phrase>
</textobject>
***************
*** 85,90 ****
--- 91,99 ----
<imageobject>
<imagedata fileref="figures/doof2d.203" format="EPS"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/doof2d-203.png" format="PNG"></imagedata>
+ </imageobject>
<textobject>
<phrase>After the Second Averaging</phrase>
</textobject>
***************
*** 484,489 ****
--- 493,501 ----
<imageobject>
<imagedata fileref="figures/doof2d.210" format="EPS" align="center"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/doof2d-210.png" format="PNG" align="center"></imagedata>
+ </imageobject>
<textobject>
<phrase>Adding two arrays is supported.</phrase>
</textobject>
***************
*** 580,585 ****
--- 592,600 ----
<imageobject>
<imagedata fileref="figures/doof2d.211" format="EPS" align="center"></imagedata>
</imageobject>
+ <imageobject>
+ <imagedata fileref="figures/doof2d-211.png" format="PNG" align="center"></imagedata>
+ </imageobject>
<textobject>
<phrase>Apply a stencil to position (1,3) of an &array;.</phrase>
</textobject>
***************
*** 713,718 ****
--- 728,736 ----
<mediaobject>
<imageobject>
<imagedata fileref="figures/distributed.101" format="EPS" align="center"></imagedata>
+ </imageobject>
+ <imageobject>
+ <imagedata fileref="figures/distributed-101.png" format="PNG" align="center"></imagedata>
</imageobject>
<textobject>
<phrase>The &pooma; distributed computation model has three
More information about the pooma-dev
mailing list