From 2ba8875a0b268d572ef2a27584d3f845ec1391b0 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Wed, 26 Apr 2000 18:02:26 +0000 Subject: Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius 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_, 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-.tar.gz in the toplevel directory. => Building the tools only is required after a "cvs co", but not in a distribution tarball. --- doc/common/Makefile.am | 8 +++++ doc/common/cpright.texi | 2 +- doc/common/dvi.gif | Bin 156 -> 0 bytes doc/common/oaronly.jpg | Bin 1584 -> 0 bytes doc/common/pdf.gif | Bin 249 -> 0 bytes doc/common/pdf1.gif | Bin 173 -> 0 bytes doc/common/ps.gif | Bin 244 -> 0 bytes doc/common/setup.texi | 75 ----------------------------------------------- doc/common/setup.texi.in | 75 +++++++++++++++++++++++++++++++++++++++++++++++ doc/common/up-arrow.gif | Bin 264 -> 0 bytes 10 files changed, 84 insertions(+), 76 deletions(-) create mode 100644 doc/common/Makefile.am delete mode 100644 doc/common/dvi.gif delete mode 100644 doc/common/oaronly.jpg delete mode 100644 doc/common/pdf.gif delete mode 100644 doc/common/pdf1.gif delete mode 100644 doc/common/ps.gif delete mode 100644 doc/common/setup.texi create mode 100644 doc/common/setup.texi.in delete mode 100644 doc/common/up-arrow.gif (limited to 'doc/common') diff --git a/doc/common/Makefile.am b/doc/common/Makefile.am new file mode 100644 index 0000000000..bbcef958c8 --- /dev/null +++ b/doc/common/Makefile.am @@ -0,0 +1,8 @@ +## $Id$ + +AUTOMAKE_OPTIONS = foreign + +EXTRA_DIST = \ +cpright.texi timemac.texi \ +timetbl.t treedef.tex wksheets.t timing.t + diff --git a/doc/common/cpright.texi b/doc/common/cpright.texi index 2d188d2394..0768c55db1 100644 --- a/doc/common/cpright.texi +++ b/doc/common/cpright.texi @@ -17,7 +17,7 @@ @end tex @vskip 0pt plus 1filll -COPYRIGHT @copyright{} 1988 - 1999.@* +COPYRIGHT @copyright{} 1988 - 2000.@* On-Line Applications Research Corporation (OAR).@* The authors have used their best efforts in preparing diff --git a/doc/common/dvi.gif b/doc/common/dvi.gif deleted file mode 100644 index 163a5d52b5..0000000000 Binary files a/doc/common/dvi.gif and /dev/null differ diff --git a/doc/common/oaronly.jpg b/doc/common/oaronly.jpg deleted file mode 100644 index c87c151404..0000000000 Binary files a/doc/common/oaronly.jpg and /dev/null differ diff --git a/doc/common/pdf.gif b/doc/common/pdf.gif deleted file mode 100644 index c88fd777c4..0000000000 Binary files a/doc/common/pdf.gif and /dev/null differ diff --git a/doc/common/pdf1.gif b/doc/common/pdf1.gif deleted file mode 100644 index 784fe2ac8c..0000000000 Binary files a/doc/common/pdf1.gif and /dev/null differ diff --git a/doc/common/ps.gif b/doc/common/ps.gif deleted file mode 100644 index 0f565bc1db..0000000000 Binary files a/doc/common/ps.gif and /dev/null differ diff --git a/doc/common/setup.texi b/doc/common/setup.texi deleted file mode 100644 index 27bb5ce266..0000000000 --- a/doc/common/setup.texi +++ /dev/null @@ -1,75 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-1999. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c - -@c -@c Set Variables -@c - -@set RTEMS-RELEASE 4.5-beta2 -@set RTEMS-EDITION 1 -@set RTEMS-VERSION 4.5-beta2 -@set RTEMS-UPDATE-DATE April 13 2000 -@set RTEMS-UPDATE-MONTH April 2000 - -@c -@c The following determines which set of the tables and figures we will use. -@c We default to ASCII but if available TeX or HTML versions will -@c be used instead. -@c - -@set use-ascii -@clear use-html -@clear use-tex - -@iftex -@clear use-ascii -@clear use-html -@set use-tex -@end iftex - -@ifhtml -@clear use-ascii -@clear use-tex -@set use-html -@end ifhtml - -@c -@c The following variable says to use texinfo or html for the two column -@c texinfo tables. For somethings the format does not look good in html. -@c With our adjustment to the left column in TeX, it nearly always looks -@c good printed. -@c -@ifset use-ascii -@set use-texinfo-tables -@end ifset -@ifset use-tex -@set use-texinfo-tables -@end ifset -@ifset use-html -@clear use-texinfo-tables -@end ifset - -@c -@c Custom whitespace adjustments. We could fiddle a bit more. -@c -@tex -\global\parindent 0in -\global\chapheadingskip = 15pt plus 4pt minus 2pt -\global\secheadingskip = 12pt plus 4pt minus 2pt -\global\subsecheadingskip = 9pt plus 4pt minus 2pt -\global\hbadness = 10000 -\global\tolerance = 6000 -\global\tableindent = 1.5in -\global\itemindent = 0.5in - -@ifclear smallbook -\global\parskip 6pt plus 1pt -@end ifclear -@end tex - - diff --git a/doc/common/setup.texi.in b/doc/common/setup.texi.in new file mode 100644 index 0000000000..0aacbe4ffb --- /dev/null +++ b/doc/common/setup.texi.in @@ -0,0 +1,75 @@ +@c +@c COPYRIGHT (c) 1988-1999. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@c +@c Set Variables +@c + +@set RTEMS-RELEASE @RTEMS_RELEASE@ +@set RTEMS-EDITION 1 +@set RTEMS-VERSION @RTEMS_VERSION@ +@set RTEMS-UPDATE-DATE February 23 2000 +@set RTEMS-UPDATE-MONTH February 2000 + +@c +@c The following determines which set of the tables and figures we will use. +@c We default to ASCII but if available TeX or HTML versions will +@c be used instead. +@c + +@set use-ascii +@clear use-html +@clear use-tex + +@iftex +@clear use-ascii +@clear use-html +@set use-tex +@end iftex + +@ifhtml +@clear use-ascii +@clear use-tex +@set use-html +@end ifhtml + +@c +@c The following variable says to use texinfo or html for the two column +@c texinfo tables. For somethings the format does not look good in html. +@c With our adjustment to the left column in TeX, it nearly always looks +@c good printed. +@c +@ifset use-ascii +@set use-texinfo-tables +@end ifset +@ifset use-tex +@set use-texinfo-tables +@end ifset +@ifset use-html +@clear use-texinfo-tables +@end ifset + +@c +@c Custom whitespace adjustments. We could fiddle a bit more. +@c +@tex +\global\parindent 0in +\global\chapheadingskip = 15pt plus 4pt minus 2pt +\global\secheadingskip = 12pt plus 4pt minus 2pt +\global\subsecheadingskip = 9pt plus 4pt minus 2pt +\global\hbadness = 10000 +\global\tolerance = 6000 +\global\tableindent = 1.5in +\global\itemindent = 0.5in + +@ifclear smallbook +\global\parskip 6pt plus 1pt +@end ifclear +@end tex + + diff --git a/doc/common/up-arrow.gif b/doc/common/up-arrow.gif deleted file mode 100644 index 82aa8ccc68..0000000000 Binary files a/doc/common/up-arrow.gif and /dev/null differ -- cgit v1.2.3