diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2000-04-26 18:02:26 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2000-04-26 18:02:26 +0000 |
commit | 2ba8875a0b268d572ef2a27584d3f845ec1391b0 (patch) | |
tree | 70279d7624be264d69e3db5ab15a2af9278be0eb /doc/supplements/template/Makefile | |
parent | Merged changes from 4.5 branch and removed that branch. (diff) | |
download | rtems-2ba8875a0b268d572ef2a27584d3f845ec1391b0.tar.bz2 |
Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <corsepiu@faw.uni-ulm.de>
which contains the bulk of converting the documentation tree to automake
and GNU conventions. Comments follow:
This is the automake port of rtemsdoc.
To apply:
cvs co rtemsdoc
cd rtemsdoc
sh cvs-rm.sh
patch -p0 < rtemsdoc-4.5.0-rc-0.diff
sh cvs-add.sh
[Attention: cvs-rm.sh and cvs-add.sh directly modify cvs]
Known bugs:
1) src2html is not supported (yet? - Is this supposed to work?)
2) all *.pdf images now are generated on-the-fly, but not yet deleted
during "make distclean"
3) All supplements, including the templated ones, get build and
installed.
4) Building outside of the source tree is completely untested and very
likely does not work.
5) Make [ps|pdf] are not (yet) supported, make [dvi|info] are supported
by automake's default texinfo rules.
Fixing 2, 3 and 5 is almost trivial and needs to be done.
4) is a matter of testing and tool-properties, for now it is simply
untested.
General issues:
* gif vs jpg vs png. I would recommend to replace all images with pngs
to avoid potential copyright issues (gif) or lack in quality (jpg, jpg
is good for real world photographs, but extremely poor on artificial
images, graphs).
* pdf images do net get placed correctly in pdf-documents.
* texinfo: We now use a local copy of texinfo-4.0's texinfo.tex in
texinfo/texinfo.tex for generating infos. However pdftex's system-wide
texinfo.tex and pdftexinfo.tex are used for generating *.dvi, *.ps, *.pdf.
* .cvsignore files still missing.
* I have renamed the supplements filename not to use c_<supplement>,
because automake seems to have problems with it.
Notes:
* Again, I recommend not to put any generated files into CVS. Here, this
comprises some *texi, all *.pdf and many *.html pages. Ie. I recommend
to run make maintainer-clean before checking in any files.
* To get building started, this should be sufficient:
./bootstrap
./configure
cd tools; make; cd ..
make info
* To make a public tarball:
[cvs co ; ./bootstrap]
./configure
cd tools; make; cd ..
make info
[make clean]
make dist
=> This generates a rtems-<version>.tar.gz in the toplevel directory.
=> Building the tools only is required after a "cvs co", but not in a
distribution tarball.
Diffstat (limited to '')
-rw-r--r-- | doc/supplements/template/Makefile | 159 | ||||
-rw-r--r-- | doc/supplements/template/Makefile.am | 115 |
2 files changed, 115 insertions, 159 deletions
diff --git a/doc/supplements/template/Makefile b/doc/supplements/template/Makefile deleted file mode 100644 index e5187e1038..0000000000 --- a/doc/supplements/template/Makefile +++ /dev/null @@ -1,159 +0,0 @@ -# -# COPYRIGHT (c) 1988-1999. -# On-Line Applications Research Corporation (OAR). -# All rights reserved. -# -# $Id$ -# - -PROJECT=template - -include ../../Make.config - -REPLACE=../../tools/word-replace - -all: html info ps pdf - -dirs: - $(make-dirs) - -COMMON_FILES=../../common/cpright.texi ../../common/setup.texi - -GENERATED_FILES=\ - cpumodel.texi callconv.texi memmodel.texi intr.texi fatalerr.texi \ - bsp.texi cputable.texi wksheets.texi timing.texi timeBSP.texi - -FILES= $(PROJECT).texi preface.texi \ - $(COMMON_FILES) $(GENERATED_FILES) - -info: dirs c_$(PROJECT) - @echo NEED TO INSTALL THE INFO FILES - #cp c_$(PROJECT) c_$(PROJECT)-* $(INFO_INSTALL) - #cp c_$(PROJECT) c_$(PROJECT)-* $(INFO_INSTALL) - -c_$(PROJECT): $(FILES) - $(MAKEINFO) $(PROJECT).texi - -dvi: dirs $(PROJECT).dvi -ps: dirs $(PROJECT).ps -pdf: dirs $(PROJECT).pdf - -$(PROJECT).pdf: $(FILES) - $(TEXI2PDF) $(PROJECT).texi - cp $(PROJECT).pdf $(WWW_INSTALL)/$(PROJECT) - -$(PROJECT).ps: $(PROJECT).dvi - dvips -o $(PROJECT).ps $(PROJECT).dvi - cp $(PROJECT).ps $(WWW_INSTALL)/$(PROJECT) - -$(PROJECT).dvi: $(FILES) - $(TEXI2DVI) $(PROJECT).texi - cp $(PROJECT).dvi $(WWW_INSTALL)/$(PROJECT) - -html: dirs $(FILES) - -mkdir -p $(WWW_INSTALL)/$(PROJECT) - $(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \ - $(PROJECT).texi - -clean: - rm -f *.o $(PROG) *.txt core $(PROJECT).pdf - rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE) - rm -f $(PROJECT) $(PROJECT)-* - rm -f c_$(PROJECT) c_$(PROJECT)-* - rm -f wksheets.t wksheets_NOTIMES.t - rm -f intr.t - rm -f timeBSP_.t timing.t - rm -f *.fixed _* $(GENERATED_FILES) - rm -f timeBSP_.t - -# -# Chapters which get automatic processing -# -cpumodel.texi: cpumodel.t Makefile - $(BMENU) -p "Preface" \ - -u "Top" \ - -n "Calling Conventions" ${*}.t - -callconv.texi: callconv.t Makefile - $(BMENU) -p "CPU Model Dependent Features Another Optional Feature" \ - -u "Top" \ - -n "Memory Model" ${*}.t - -memmodel.texi: memmodel.t Makefile - $(BMENU) -p "Calling Conventions User-Provided Routines" \ - -u "Top" \ - -n "Interrupt Processing" ${*}.t - -# Interrupt Chapter: -# 1. Replace Times and Sizes -# 2. Build Node Structure -intr.t: intr_NOTIMES.t BSP_TIMES - ${REPLACE} -p BSP_TIMES intr_NOTIMES.t - mv intr_NOTIMES.t.fixed intr.t - -intr.texi: intr.t Makefile - $(BMENU) -p "Memory Model Flat Memory Model" \ - -u "Top" \ - -n "Default Fatal Error Processing" ${*}.t - -fatalerr.texi: fatalerr.t Makefile - $(BMENU) -p "Interrupt Processing Interrupt Stack" \ - -u "Top" \ - -n "Board Support Packages" ${*}.t - -bsp.texi: bsp.t Makefile - $(BMENU) -p "Default Fatal Error Processing Default Fatal Error Handler Operations" \ - -u "Top" \ - -n "Processor Dependent Information Table" ${*}.t - -cputable.texi: cputable.t Makefile - $(BMENU) -p "Board Support Packages Processor Initialization" \ - -u "Top" \ - -n "Memory Requirements" ${*}.t - -# Worksheets Chapter: -# 1. Copy the Shared File -# 2. Replace Times and Sizes -# 3. Build Node Structure - -wksheets_NOTIMES.t: ../../common/wksheets.t - cp ../../common/wksheets.t wksheets_NOTIMES.t - -wksheets.t: wksheets_NOTIMES.t BSP_TIMES - ${REPLACE} -p BSP_TIMES wksheets_NOTIMES.t - mv wksheets_NOTIMES.t.fixed wksheets.t - -wksheets.texi: wksheets.t Makefile - $(BMENU) -p "Processor Dependent Information Table CPU Dependent Information Table" \ - -u "Top" \ - -n "Timing Specification" ${*}.t - -# Timing Specification Chapter: -# 1. Copy the Shared File -# 3. Build Node Structure - -timing.t: ../../common/timing.t - cp ../../common/timing.t timing.t - -timing.texi: timing.t Makefile - $(BMENU) -p "Memory Requirements RTEMS RAM Workspace Worksheet" \ - -u "Top" \ - -n "BSP_FOR_TIMES Timing Data" ${*}.t - -# Timing Data for BSP Chapter: -# 1. Copy the Shared File -# 2. Replace Times and Sizes -# 3. Build Node Structure - -timeBSP_.t: ../../common/timetbl.t timeBSP.t - cat timeBSP.t ../../common/timetbl.t >timeBSP_.t - @echo >>timeBSP_.t - @echo "@tex" >>timeBSP_.t - @echo "\\global\\advance \\smallskipamount by 4pt" >>timeBSP_.t - @echo "@end tex" >>timeBSP_.t - -timeBSP.texi: timeBSP_.t Makefile - $(BMENU) -p "Timing Specification Terminology" \ - -u "Top" \ - -n "Command and Variable Index" timeBSP_.t - mv timeBSP_.t timeBSP.texi diff --git a/doc/supplements/template/Makefile.am b/doc/supplements/template/Makefile.am new file mode 100644 index 0000000000..1d743aa2b7 --- /dev/null +++ b/doc/supplements/template/Makefile.am @@ -0,0 +1,115 @@ +# +# COPYRIGHT (c) 1988-1999. +# On-Line Applications Research Corporation (OAR). +# All rights reserved. +# +# $Id$ +# + +AUTOMAKE_OPTIONS = foreign + +PROJECT=template + +include $(top_srcdir)/project.am +include $(top_srcdir)/supplements/supplement.am + +COMMON_FILES= $(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi + +GENERATED_FILES=\ + cpumodel.texi callconv.texi memmodel.texi intr.texi fatalerr.texi \ + bsp.texi cputable.texi wksheets.texi timing.texi timeBSP.texi + +FILES= preface.texi + +info_TEXINFOS = template.texi +template_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) + +# +# Chapters which get automatic processing +# +cpumodel.texi: cpumodel.t + $(BMENU) -p "Preface" \ + -u "Top" \ + -n "Calling Conventions" $< + +callconv.texi: callconv.t + $(BMENU) -p "CPU Model Dependent Features Another Optional Feature" \ + -u "Top" \ + -n "Memory Model" $< + +memmodel.texi: memmodel.t + $(BMENU) -p "Calling Conventions User-Provided Routines" \ + -u "Top" \ + -n "Interrupt Processing" $< + +# Interrupt Chapter: +# 1. Replace Times and Sizes +# 2. Build Node Structure +intr.texi: intr_NOTIMES.t BSP_TIMES + ${REPLACE2} -p $(srcdir)/BSP_TIMES $(srcdir)/intr_NOTIMES.t intr.t + $(BMENU) -p "Memory Model Flat Memory Model" \ + -u "Top" \ + -n "Default Fatal Error Processing" intr.t +CLEANFILES += intr.t + +fatalerr.texi: fatalerr.t + $(BMENU) -p "Interrupt Processing Interrupt Stack" \ + -u "Top" \ + -n "Board Support Packages" $< + +bsp.texi: bsp.t + $(BMENU) -p "Default Fatal Error Processing Default Fatal Error Handler Operations" \ + -u "Top" \ + -n "Processor Dependent Information Table" $< + +cputable.texi: cputable.t + $(BMENU) -p "Board Support Packages Processor Initialization" \ + -u "Top" \ + -n "Memory Requirements" $< + +# Worksheets Chapter: +# 1. Obtain the Shared File +# 2. Replace Times and Sizes +# 3. Build Node Structure + +wksheets.texi: $(top_srcdir)/common/wksheets.t BSP_TIMES + ${REPLACE2} -p $(srcdir)/BSP_TIMES \ + $(top_srcdir)/common/wksheets.t wksheets.t + $(BMENU) -p "Processor Dependent Information Table CPU Dependent Information Table" \ + -u "Top" \ + -n "Timing Specification" wksheets.t +CLEANFILES += wksheets.t + +# Timing Specification Chapter: +# 1. Copy the Shared File +# 3. Build Node Structure + +timing.texi: $(top_srcdir)/common/timing.t + cp $(top_srcdir)/common/timing.t timing.t + $(BMENU) -p "Memory Requirements RTEMS RAM Workspace Worksheet" \ + -u "Top" \ + -n "MYBSP Timing Data" timing.t +CLEANFILES += timing.t + +# Timing Data for BSP BSP Chapter: +# 1. Copy the Shared File +# 2. Replace Times and Sizes +# 3. Build Node Structure + +timeBSP_.t: $(top_srcdir)/common/timetbl.t timeBSP.t + cat timeBSP.t $(top_srcdir)/common/timetbl.t >timeBSP_.t + @echo >>timeBSP_.t + @echo "@tex" >>timeBSP_.t + @echo "\\global\\advance \\smallskipamount by 4pt" >>timeBSP_.t + @echo "@end tex" >>timeBSP_.t + ${REPLACE} -p BSP_TIMES timeBSP_.t + mv timeBSP_.t.fixed timeBSP_.t +MAINTAINERCLEANFILES += timeBSP_.t + +timeBSP.texi: timeBSP_.t + $(BMENU) -p "Timing Specification Terminology" \ + -u "Top" \ + -n "Command and Variable Index" timeBSP_.t + mv timeBSP_.texi timeBSP.texi + +EXTRA_DIST = BSP_TIMES *.t |