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/porting | |
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 'doc/porting')
-rw-r--r-- | doc/porting/Makefile.am (renamed from doc/porting/Makefile) | 67 |
1 files changed, 17 insertions, 50 deletions
diff --git a/doc/porting/Makefile b/doc/porting/Makefile.am index b612e6e095..7e1cd643e1 100644 --- a/doc/porting/Makefile +++ b/doc/porting/Makefile.am @@ -6,16 +6,14 @@ # $Id$ # -PROJECT=porting +AUTOMAKE_OPTIONS = foreign -include ../Make.config +PROJECT=porting -all: html info ps pdf +include $(top_srcdir)/project.am -dirs: - $(make-dirs) +COMMON_FILES=$(top_srcdir)/common/cpright.texi -COMMON_FILES=../common/cpright.texi FILES=preface.texi developtools.texi sourcecode.texi cpumodels.texi \ cpuinit.texi interrupts.texi taskcontext.texi idlethread.texi \ prioritybitmap.texi codetuning.texi miscellaneous.texi $(COMMON_FILES) @@ -24,88 +22,57 @@ GENERATED_FILES=developtools.texi sourcecode.texi cpumodels.texi \ cpuinit.texi interrupts.texi taskcontext.texi idlethread.texi \ prioritybitmap.texi codetuning.texi miscellaneous.texi - -INFOFILES=$(wildcard $(PROJECT) $(PROJECT)-*) - -info: dirs $(PROJECT) - cp $(PROJECT) $(PROJECT)-* $(INFO_INSTALL) - -$(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 *.html $(PROJECT).pdf - rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE) - rm -f $(PROJECT) $(PROJECT)-* _* $(GENERATED_FILES) +info_TEXINFOS = porting.texi +porting_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) developtools.texi: developtools.t $(BMENU) -p "Preface" \ -u "Top" \ - -n "Source Code Organization" ${*}.t + -n "Source Code Organization" $< sourcecode.texi: sourcecode.t $(BMENU) -p "Development Tools" \ -u "Top" \ - -n "CPU Model Variations" ${*}.t + -n "CPU Model Variations" $< cpumodels.texi: cpumodels.t $(BMENU) -p "Source Code Organization Introduction" \ -u "Top" \ - -n "CPU Initialization" ${*}.t + -n "CPU Initialization" $< cpuinit.texi: cpuinit.t $(BMENU) -p "CPU Model Variations Coding Issues" \ -u "Top" \ - -n "Interrupts" ${*}.t + -n "Interrupts" $< interrupts.texi: interrupts.t $(BMENU) -p "CPU Initialization Initializing the CPU" \ -u "Top" \ - -n "Task Context Management" ${*}.t + -n "Task Context Management" $< taskcontext.texi: taskcontext.t $(BMENU) -p "Interrupts Pointer to _Thread_Dispatch Routine" \ -u "Top" \ - -n "IDLE Thread" ${*}.t + -n "IDLE Thread" $< idlethread.texi: idlethread.t $(BMENU) -p "Task Context Management Restoring a Floating Point Context" \ -u "Top" \ - -n "Priority Bitmap Manipulation" ${*}.t + -n "Priority Bitmap Manipulation" $< prioritybitmap.texi: prioritybitmap.t $(BMENU) -p "IDLE Thread Idle Thread Body" \ -u "Top" \ - -n "Code Tuning Parameters" ${*}.t + -n "Code Tuning Parameters" $< codetuning.texi: codetuning.t $(BMENU) -p "Priority Bitmap Manipulation Bit Scan Support" \ -u "Top" \ - -n "Miscellaneous" ${*}.t + -n "Miscellaneous" $< miscellaneous.texi: miscellaneous.t $(BMENU) -p "Code Tuning Parameters Partition Element Alignment" \ -u "Top" \ - -n "Command and Variable Index" ${*}.t + -n "Command and Variable Index" $< +EXTRA_DIST = *.t |