source: rtems/doc/common/setup.texi.in @ 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: 1.5 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1999.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@c
10@c  Set Variables
11@c
12
13@set RTEMS-RELEASE @RTEMS_RELEASE@
14@set RTEMS-EDITION 1
15@set RTEMS-VERSION @RTEMS_VERSION@
16@set RTEMS-UPDATE-DATE February 23 2000
17@set RTEMS-UPDATE-MONTH February 2000
18
19@c
20@c  The following determines which set of the tables and figures we will use.
21@c  We default to ASCII but if available TeX or HTML versions will
22@c  be used instead.
23@c
24
25@set use-ascii
26@clear use-html
27@clear use-tex
28 
29@iftex
30@clear use-ascii
31@clear use-html
32@set use-tex
33@end iftex
34 
35@ifhtml
36@clear use-ascii
37@clear use-tex
38@set use-html
39@end ifhtml
40
41@c
42@c The following variable says to use texinfo or html for the two column
43@c texinfo tables.  For somethings the format does not look good in html.
44@c With our adjustment to the left column in TeX, it nearly always looks
45@c good printed.
46@c
47@ifset use-ascii
48@set use-texinfo-tables
49@end ifset
50@ifset use-tex
51@set use-texinfo-tables
52@end ifset
53@ifset use-html
54@clear use-texinfo-tables
55@end ifset
56
57@c
58@c Custom whitespace adjustments.  We could fiddle a bit more.
59@c
60@tex
61\global\parindent 0in
62\global\chapheadingskip = 15pt plus 4pt minus 2pt
63\global\secheadingskip = 12pt plus 4pt minus 2pt
64\global\subsecheadingskip = 9pt plus 4pt minus 2pt
65\global\hbadness = 10000
66\global\tolerance = 6000
67\global\tableindent = 1.5in
68\global\itemindent = 0.5in
69
70@ifclear smallbook
71\global\parskip 6pt plus 1pt
72@end ifclear
73@end tex
74
75
Note: See TracBrowser for help on using the repository browser.