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/bsp_howto/Makefile.am | |
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/bsp_howto/Makefile.am')
-rw-r--r-- | doc/bsp_howto/Makefile.am | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/doc/bsp_howto/Makefile.am b/doc/bsp_howto/Makefile.am new file mode 100644 index 0000000000..4657bbe873 --- /dev/null +++ b/doc/bsp_howto/Makefile.am @@ -0,0 +1,118 @@ +# +# COPYRIGHT (c) 1988-1999. +# On-Line Applications Research Corporation (OAR). +# All rights reserved. +# +# $Id$ +# + +AUTOMAKE_OPTIONS = foreign + +PROJECT=bsp_howto + +include $(top_srcdir)/project.am + +COMMON_FILES=$(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi + +GENERATED_FILES= \ + intro.texi target.texi makefiles.texi linkcmds.texi support.texi \ + adaintr.texi init.texi console.texi clock.texi timer.texi rtc.texi \ + nvmem.texi network.texi shmsupp.texi analog.texi discrete.texi + +FILES= + +info_TEXINFOS = bsp_howto.texi +bsp_howto_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) + +# +# Grab the chapter on writing a network device driver. +# +network.t: + ln -s ../networking/driver.t network.t + + +# +# Process Automatically Generated Files +# + +intro.texi: intro.t + $(BMENU) -p "Top" \ + -u "Top" \ + -n "Target Dependent Files" $< + +target.texi: target.t + $(BMENU) -p "Introduction" \ + -u "Top" \ + -n "Makefiles" $< + +makefiles.texi: makefiles.t + $(BMENU) -p "Target Dependent Files Board Support Package Structure" \ + -u "Top" \ + -n "Linker Script" $< + +linkcmds.texi: linkcmds.t + $(BMENU) -p "Makefiles Creating a New BSP Make Customization File" \ + -u "Top" \ + -n "Ada95 Interrupt Support" $< + +adaintr.texi: adaintr.t + $(BMENU) -p "Linker Script Initialized Data" \ + -u "Top" \ + -n "Miscellaneous Support Files" $< + +support.texi: support.t + $(BMENU) -p "Ada95 Interrupt Support Version Requirements" \ + -u "Top" \ + -n "" $< + +init.texi: init.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +console.texi: console.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +clock.texi: clock.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +timer.texi: timer.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +rtc.texi: rtc.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +nvmem.texi: nvmem.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +network.texi: network.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +shmsupp.texi: shmsupp.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +analog.texi: analog.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +discrete.texi: discrete.t + $(BMENU) -p "" \ + -u "Top" \ + -n "" $< + +EXTRA_DIST = *.t |