source: rtems/doc/supplements/sparc/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.3 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=sparc
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 timing.texi wksheets.texi timeERC32.texi
21
22FILES= preface.texi
23
24info_TEXINFOS = sparc.texi
25sparc_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
26
27#
28#  Chapters which get automatic processing
29#
30
31cpumodel.texi: cpumodel.t
32        $(BMENU) -p "Preface" \
33            -u "Top" \
34            -n "Calling Conventions" $<
35
36callconv.texi: callconv.t
37        $(BMENU) -p "CPU Model Dependent Features CPU Model Implementation Notes" \
38            -u "Top" \
39            -n "Memory Model" $<
40
41memmodel.texi: memmodel.t
42        $(BMENU) -p "Calling Conventions User-Provided Routines" \
43            -u "Top" \
44            -n "Interrupt Processing" $<
45
46# Interrupt Chapter:
47#  1.  Replace Times and Sizes
48#  2.  Build Node Structure
49intr.texi: intr_NOTIMES.t ERC32_TIMES
50        ${REPLACE2} -p $(srcdir)/ERC32_TIMES $(srcdir)/intr_NOTIMES.t intr.t
51        $(BMENU) -p "Memory Model Flat Memory Model" \
52            -u "Top" \
53            -n "Default Fatal Error Processing" intr.t
54CLEANFILES += intr.t
55
56fatalerr.texi: fatalerr.t
57        $(BMENU) -p "Interrupt Processing Interrupt Stack" \
58            -u "Top" \
59            -n "Board Support Packages" $<
60
61bsp.texi: bsp.t
62        $(BMENU) -p "Default Fatal Error Processing Default Fatal Error Handler Operations" \
63            -u "Top" \
64            -n "Processor Dependent Information Table" $<
65
66cputable.texi: cputable.t
67        $(BMENU) -p "Board Support Packages Processor Initialization" \
68            -u "Top" \
69            -n "Memory Requirements" $<
70
71
72# Worksheets Chapter:
73#  1.  Obtain the Shared File
74#  2.  Replace Times and Sizes
75#  3.  Build Node Structure
76
77wksheets.texi: $(top_srcdir)/common/wksheets.t ERC32_TIMES
78        ${REPLACE2} -p $(srcdir)/ERC32_TIMES \
79          $(top_srcdir)/common/wksheets.t wksheets.t
80        $(BMENU) -p "Processor Dependent Information Table CPU Dependent Information Table" \
81            -u "Top" \
82            -n "Timing Specification" wksheets.t
83CLEANFILES += wksheets.t
84
85# Timing Specification Chapter:
86#  1.  Copy the Shared File
87#  3.  Build Node Structure
88timing.texi: $(top_srcdir)/common/timing.t
89        cp $(top_srcdir)/common/timing.t timing.t
90        $(BMENU) -p "Memory Requirements RTEMS RAM Workspace Worksheet" \
91            -u "Top" \
92            -n "ERC32 Timing Data" timing.t
93CLEANFILES += timing.t
94
95
96# Timing Data for ERC32 BSP Chapter:
97#  1.  Copy the Shared File
98#  2.  Replace Times and Sizes
99#  3.  Build Node Structure
100
101timeERC32_.t: $(top_srcdir)/common/timetbl.t timeERC32.t
102        cat timeERC32.t $(top_srcdir)/common/timetbl.t               >timeERC32_.t
103        @echo                                               >>timeERC32_.t
104        @echo "@tex"                                        >>timeERC32_.t
105        @echo "\\global\\advance \\smallskipamount by 4pt"  >>timeERC32_.t
106        @echo "@end tex"                                    >>timeERC32_.t
107        ${REPLACE} -p ERC32_TIMES timeERC32_.t
108        mv timeERC32_.t.fixed timeERC32_.t
109
110timeERC32.texi: timeERC32_.t
111        $(BMENU) -p "Timing Specification Terminology" \
112            -u "Top" \
113            -n "Command and Variable Index" timeERC32_.t
114        mv timeERC32_.texi timeERC32.texi
115
116EXTRA_DIST = ERC32_TIMES *.t
Note: See TracBrowser for help on using the repository browser.