diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2000-04-26 18:02:26 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2000-04-26 18:02:26 +0000 |
commit | 2ba8875a0b268d572ef2a27584d3f845ec1391b0 (patch) | |
tree | 70279d7624be264d69e3db5ab15a2af9278be0eb /doc/common | |
parent | Merged changes from 4.5 branch and removed that branch. (diff) | |
download | rtems-2ba8875a0b268d572ef2a27584d3f845ec1391b0.tar.bz2 |
Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <corsepiu@faw.uni-ulm.de>
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.
Diffstat (limited to 'doc/common')
-rw-r--r-- | doc/common/Makefile.am | 8 | ||||
-rw-r--r-- | doc/common/cpright.texi | 2 | ||||
-rw-r--r-- | doc/common/dvi.gif | bin | 156 -> 0 bytes | |||
-rw-r--r-- | doc/common/oaronly.jpg | bin | 1584 -> 0 bytes | |||
-rw-r--r-- | doc/common/pdf.gif | bin | 249 -> 0 bytes | |||
-rw-r--r-- | doc/common/pdf1.gif | bin | 173 -> 0 bytes | |||
-rw-r--r-- | doc/common/ps.gif | bin | 244 -> 0 bytes | |||
-rw-r--r-- | doc/common/setup.texi.in (renamed from doc/common/setup.texi) | 8 | ||||
-rw-r--r-- | doc/common/up-arrow.gif | bin | 264 -> 0 bytes |
9 files changed, 13 insertions, 5 deletions
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 Binary files differdeleted file mode 100644 index 163a5d52b5..0000000000 --- a/doc/common/dvi.gif +++ /dev/null diff --git a/doc/common/oaronly.jpg b/doc/common/oaronly.jpg Binary files differdeleted file mode 100644 index c87c151404..0000000000 --- a/doc/common/oaronly.jpg +++ /dev/null diff --git a/doc/common/pdf.gif b/doc/common/pdf.gif Binary files differdeleted file mode 100644 index c88fd777c4..0000000000 --- a/doc/common/pdf.gif +++ /dev/null diff --git a/doc/common/pdf1.gif b/doc/common/pdf1.gif Binary files differdeleted file mode 100644 index 784fe2ac8c..0000000000 --- a/doc/common/pdf1.gif +++ /dev/null diff --git a/doc/common/ps.gif b/doc/common/ps.gif Binary files differdeleted file mode 100644 index 0f565bc1db..0000000000 --- a/doc/common/ps.gif +++ /dev/null diff --git a/doc/common/setup.texi b/doc/common/setup.texi.in index 27bb5ce266..0aacbe4ffb 100644 --- a/doc/common/setup.texi +++ b/doc/common/setup.texi.in @@ -10,11 +10,11 @@ @c Set Variables @c -@set RTEMS-RELEASE 4.5-beta2 +@set RTEMS-RELEASE @RTEMS_RELEASE@ @set RTEMS-EDITION 1 -@set RTEMS-VERSION 4.5-beta2 -@set RTEMS-UPDATE-DATE April 13 2000 -@set RTEMS-UPDATE-MONTH April 2000 +@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. diff --git a/doc/common/up-arrow.gif b/doc/common/up-arrow.gif Binary files differdeleted file mode 100644 index 82aa8ccc68..0000000000 --- a/doc/common/up-arrow.gif +++ /dev/null |