source: rtems/doc/supplements/template/template.texi @ 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: 2.5 KB
Line 
1\input texinfo   @c -*-texinfo-*-
2@c %**start of header
3@setfilename template
4@syncodeindex vr fn
5@synindex ky cp
6@paragraphindent 0
7@c @smallbook
8@c %**end of header
9
10@c
11@c  COPYRIGHT (c) 1988-1999.
12@c  On-Line Applications Research Corporation (OAR).
13@c  All rights reserved.
14@c
15@c  $Id$
16@c
17
18@c
19@c   Master file for the Template Applications Supplement
20@c
21
22@include ../../common/setup.texi
23
24@ignore
25@ifinfo
26@format
27START-INFO-DIR-ENTRY
28* RTEMS Template Applications Supplement (template):
29END-INFO-DIR-ENTRY
30@end format
31@end ifinfo
32@end ignore
33
34@c
35@c  Title Page Stuff
36@c
37
38@set edition @value{RTEMS-EDITION}
39@set version @value{RTEMS-VERSION}
40@set update-date @value{RTEMS-UPDATE-DATE}
41@set update-month @value{RTEMS-UPDATE-MONTH}
42
43@c
44@c  I don't really like having a short title page.  --joel
45@c
46@c @shorttitlepage RTEMS Template Applications Supplement
47
48@setchapternewpage odd
49@settitle RTEMS Template Applications Supplement
50@titlepage
51@finalout
52
53@title RTEMS Template Applications Supplement
54@subtitle Edition @value{edition}, for RTEMS @value{version}
55@sp 1
56@subtitle @value{update-month}
57@author On-Line Applications Research Corporation
58@page
59
60@include ../../common/cpright.texi
61@end titlepage
62
63@c  This prevents a black box from being printed on "overflow" lines.
64@c  The alternative is to rework a sentence to avoid this problem.
65
66@include preface.texi
67@include cpumodel.texi
68@include callconv.texi
69@include memmodel.texi
70@include intr.texi
71@include fatalerr.texi
72@include bsp.texi
73@include cputable.texi
74@include wksheets.texi
75@include timing.texi
76@include timeBSP.texi
77@ifinfo
78@node Top, Preface, (dir), (dir)
79@top template
80
81This is the online version of the RTEMS Template
82Applications Supplement.
83
84@menu
85* Preface::
86* CPU Model Dependent Features::
87* Calling Conventions::
88* Memory Model::
89* Interrupt Processing::
90* Default Fatal Error Processing::
91* Board Support Packages::
92* Processor Dependent Information Table::
93* Memory Requirements::
94* Timing Specification::
95* MYBSP Timing Data::
96* Command and Variable Index::
97* Concept Index::
98@end menu
99
100@end ifinfo
101@c
102@c
103@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
104@c
105
106@node Command and Variable Index, Concept Index, MYBSP Timing Data Rate Monotonic Manager, Top
107@unnumbered Command and Variable Index
108
109There are currently no Command and Variable Index entries.
110
111@c @printindex fn
112
113@node Concept Index, , Command and Variable Index, Top
114@unnumbered Concept Index
115
116There are currently no Concept Index entries.
117@c @printindex cp
118
119@contents
120@bye
121
Note: See TracBrowser for help on using the repository browser.