source: rtems/doc/supplements/mips64orion/Makefile.am @ 2ba8875

4.104.114.84.95
Last change on this file since 2ba8875 was 2ba8875, checked in by Joel Sherrill <joel.sherrill@…>, on 04/26/00 at 18:02:26

Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <corsepiu@…>
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.

  • Property mode set to 100644
File size: 3.2 KB
Line 
1#
2#  COPYRIGHT (c) 1988-1999.
3#  On-Line Applications Research Corporation (OAR).
4#  All rights reserved.
5#
6#  $Id$
7#
8
9AUTOMAKE_OPTIONS = foreign
10
11PROJECT=mips64orion
12
13include $(top_srcdir)/project.am
14include $(top_srcdir)/supplements/supplement.am
15
16COMMON_FILES=$(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi
17
18GENERATED_FILES=\
19  cpumodel.texi callconv.texi memmodel.texi intr.texi fatalerr.texi \
20  bsp.texi cputable.texi wksheets.texi timing.texi timeBSP.texi
21
22FILES= preface.texi
23
24info_TEXINFOS = mips64orion.texi
25mips64orion_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
26
27#
28#  Chapters which get automatic processing
29#
30cpumodel.texi: cpumodel.t
31        $(BMENU) -p "Preface" \
32            -u "Top" \
33            -n "Calling Conventions" $<
34
35callconv.texi: callconv.t
36        $(BMENU) -p "CPU Model Dependent Features Another Optional Feature" \
37            -u "Top" \
38            -n "Memory Model" $<
39
40memmodel.texi: memmodel.t
41        $(BMENU) -p "Calling Conventions User-Provided Routines" \
42            -u "Top" \
43            -n "Interrupt Processing" $<
44
45# Interrupt Chapter:
46#  1.  Replace Times and Sizes
47#  2.  Build Node Structure
48intr.texi: intr_NOTIMES.t BSP_TIMES
49        ${REPLACE2} -p $(srcdir)/BSP_TIMES $(srcdir)/intr_NOTIMES.t intr.t
50        $(BMENU) -p "Memory Model Flat Memory Model" \
51            -u "Top" \
52            -n "Default Fatal Error Processing" intr.t
53CLEANFILES += intr.t
54
55fatalerr.texi: fatalerr.t
56        $(BMENU) -p "Interrupt Processing Interrupt Stack" \
57            -u "Top" \
58            -n "Board Support Packages" $<
59
60bsp.texi: bsp.t
61        $(BMENU) -p "Default Fatal Error Processing Default Fatal Error Handler Operations" \
62            -u "Top" \
63            -n "Processor Dependent Information Table" $<
64
65cputable.texi: cputable.t
66        $(BMENU) -p "Board Support Packages Processor Initialization" \
67            -u "Top" \
68            -n "Memory Requirements" $<
69
70# Worksheets Chapter:
71#  1.  Copy the Shared File
72#  2.  Replace Times and Sizes
73#  3.  Build Node Structure
74
75wksheets.texi: $(top_srcdir)/common/wksheets.t BSP_TIMES
76        ${REPLACE2} -p $(srcdir)/BSP_TIMES \
77          $(top_srcdir)/common/wksheets.t wksheets.t
78        $(BMENU) -p "Processor Dependent Information Table CPU Dependent Information Table" \
79            -u "Top" \
80            -n "Timing Specification" wksheets.t
81CLEANFILES += wksheets.t
82
83# Timing Specification Chapter:
84#  1.  Copy the Shared File
85#  3.  Build Node Structure
86
87timing.texi: $(top_srcdir)/common/timing.t
88        cp $(top_srcdir)/common/timing.t timing.t
89        $(BMENU) -p "Memory Requirements RTEMS RAM Workspace Worksheet" \
90            -u "Top" \
91            -n "BSP_FOR_TIMES Timing Data" timing.t
92CLEANFILES += timing.t
93
94# Timing Data for BSP Chapter:
95#  1.  Copy the Shared File
96#  2.  Replace Times and Sizes
97#  3.  Build Node Structure
98
99timeBSP_.t: $(top_srcdir)/common/timetbl.t timeBSP.t
100        cat timeBSP.t $(top_srcdir)/common/timetbl.t                 >timeBSP_.t
101        @echo                                               >>timeBSP_.t
102        @echo "@tex"                                        >>timeBSP_.t
103        @echo "\\global\\advance \\smallskipamount by 4pt"  >>timeBSP_.t
104        @echo "@end tex"                                    >>timeBSP_.t
105        ${REPLACE} -p BSP_TIMES timeBSP_.t
106        mv timeBSP_.t.fixed timeBSP_.t
107
108timeBSP.texi: timeBSP_.t
109        $(BMENU) -p "Timing Specification Terminology" \
110            -u "Top" \
111            -n "Command and Variable Index" timeBSP_.t
112        mv timeBSP_.texi timeBSP.texi
113
114EXTRA_DIST = BSP_TIMES *.t
Note: See TracBrowser for help on using the repository browser.