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/started/Makefile | 102 --------------------------------------- doc/started/Makefile.am | 67 +++++++++++++++++++++++++ doc/started/pictures/Makefile.am | 13 +++++ doc/started/started.texi | 2 +- doc/started/tversions.texi | 92 +++++++++++++++++++++++++++++++++++ doc/started/versions.texi | 92 ----------------------------------- 6 files changed, 173 insertions(+), 195 deletions(-) delete mode 100644 doc/started/Makefile create mode 100644 doc/started/Makefile.am create mode 100644 doc/started/pictures/Makefile.am create mode 100644 doc/started/tversions.texi delete mode 100644 doc/started/versions.texi (limited to 'doc/started') diff --git a/doc/started/Makefile b/doc/started/Makefile deleted file mode 100644 index fbe2f39ee3..0000000000 --- a/doc/started/Makefile +++ /dev/null @@ -1,102 +0,0 @@ -# -# COPYRIGHT (c) 1988-1999. -# On-Line Applications Research Corporation (OAR). -# All rights reserved. -# -# $Id$ -# - -PROJECT=started - -include ../Make.config - -all: html info ps pdf - -dirs: - $(make-dirs) - -COMMON_FILES=../common/cpright.texi ../common/setup.texi - -GENERATED_FILES= binaries.texi buildc.texi buildrt.texi gdb.texi intro.texi \ - nt.texi require.texi sample.texi - -FILES= $(PROJECT).texi versions.texi $(GENERATED_FILES) - -INFOFILES=$(wildcard $(PROJECT) $(PROJECT)-*) - -info: dirs $(PROJECT) - #cp $(wildcard $(PROJECT) $(PROJECT)-*) $(INFO_INSTALL) - cp $(PROJECT) $(INFO_INSTALL) - -$(PROJECT): $(FILES) - $(MAKEINFO) $(PROJECT).texi - -dvi: dirs $(PROJECT).dvi -ps: dirs $(PROJECT).ps -pdf: dirs $(PROJECT).pdf - -$(PROJECT).pdf: $(FILES) - #$(TEXI2PDF) $(PROJECT).texi - #cp $(PROJECT).pdf $(WWW_INSTALL)/$(PROJECT) - -$(PROJECT).ps: $(PROJECT).dvi - dvips -o $(PROJECT).ps $(PROJECT).dvi - cp $(PROJECT).ps $(WWW_INSTALL)/$(PROJECT) - -$(PROJECT).dvi: $(FILES) - $(TEXI2DVI) $(PROJECT).texi - cp $(PROJECT).dvi $(WWW_INSTALL)/$(PROJECT) - -intro.texi: intro.t versions.texi - $(BMENU) -c -p "Top" \ - -u "Top" \ - -n "Requirements" ${*}.t - -require.texi: require.t versions.texi - $(BMENU) -c -p "EGCS Mailing List" \ - -u "Top" \ - -n "Prebuilt Toolset Executables" ${*}.t - -binaries.texi: binaries.t versions.texi - $(BMENU) -c -p "GNU makeinfo Version Requirements" \ - -u "Top" \ - -n "Building the GNU C/C++ Cross Compiler Toolset" ${*}.t - -buildc.texi: buildc.t versions.texi - $(BMENU) -c -p "Removing RPMs" \ - -u "Top" \ - -n "Building RTEMS" ${*}.t - -buildrt.texi: buildrt.t versions.texi - $(BMENU) -c -p "Error Messages Indicating Configuration Problems" \ - -u "Top" \ - -n "Building the Sample Application" ${*}.t - -sample.texi: sample.t versions.texi - $(BMENU) -c -p "Using the RTEMS configure Script Directly" \ - -u "Top" \ - -n "Building the GNU Debugger" ${*}.t - -gdb.texi: gdb.t versions.texi - $(BMENU) -c -p "Application Executable" \ - -u "Top" \ - -n "Using MS-Windows as a Development Host" ${*}.t - -nt.texi: nt.t versions.texi - $(BMENU) -c -p "GDB for DINK32" \ - -u "Top" \ - -n "" ${*}.t - -html: dirs $(FILES) - -mkdir -p $(WWW_INSTALL)/$(PROJECT) - -cp pictures/sfile12c.jpg $(WWW_INSTALL)/$(PROJECT) - -cp pictures/bit_c.jpg $(WWW_INSTALL)/$(PROJECT) - $(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \ - $(PROJECT).texi - -clean: - rm -f *.o $(PROG) *.txt core $(PROJECT).pdf - rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE) - rm -f $(PROJECT) $(PROJECT)-* $(GENERATED_FILES) - rm -f *.fixed _* - diff --git a/doc/started/Makefile.am b/doc/started/Makefile.am new file mode 100644 index 0000000000..3fa305343d --- /dev/null +++ b/doc/started/Makefile.am @@ -0,0 +1,67 @@ +# +# COPYRIGHT (c) 1988-1999. +# On-Line Applications Research Corporation (OAR). +# All rights reserved. +# +# $Id$ +# + +AUTOMAKE_OPTIONS = foreign + +PROJECT=started + +SUBDIRS = pictures + +include $(top_srcdir)/project.am + +COMMON_FILES=$(top_srcdir)/common/cpright.texi $(top_builddir)/common/setup.texi + +GENERATED_FILES= binaries.texi buildc.texi buildrt.texi gdb.texi intro.texi \ + nt.texi require.texi sample.texi + +FILES= tversions.texi + +info_TEXINFOS = started.texi +started_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) + +intro.texi: intro.t tversions.texi + $(BMENU) -c -p "Top" \ + -u "Top" \ + -n "Requirements" $< + +require.texi: require.t tversions.texi + $(BMENU) -c -p "EGCS Mailing List" \ + -u "Top" \ + -n "Prebuilt Toolset Executables" $< + +binaries.texi: binaries.t tversions.texi + $(BMENU) -c -p "GNU makeinfo Version Requirements" \ + -u "Top" \ + -n "Building the GNU C/C++ Cross Compiler Toolset" $< + +buildc.texi: buildc.t tversions.texi + $(BMENU) -c -p "Removing RPMs" \ + -u "Top" \ + -n "Building RTEMS" $< + +buildrt.texi: buildrt.t tversions.texi + $(BMENU) -c -p "Error Messages Indicating Configuration Problems" \ + -u "Top" \ + -n "Building the Sample Application" $< + +sample.texi: sample.t tversions.texi + $(BMENU) -c -p "Using the RTEMS configure Script Directly" \ + -u "Top" \ + -n "Building the GNU Debugger" $< + +gdb.texi: gdb.t tversions.texi + $(BMENU) -c -p "Application Executable" \ + -u "Top" \ + -n "Using MS-Windows as a Development Host" $< + +nt.texi: nt.t tversions.texi + $(BMENU) -c -p "GDB for DINK32" \ + -u "Top" \ + -n "" $< + +EXTRA_DIST = *.t diff --git a/doc/started/pictures/Makefile.am b/doc/started/pictures/Makefile.am new file mode 100644 index 0000000000..45e81830b1 --- /dev/null +++ b/doc/started/pictures/Makefile.am @@ -0,0 +1,13 @@ +## $Id$ + +AUTOMAKE_OPTIONS = foreign + +PROJECT = started + +html_projectdir = $(htmldir)/$(PROJECT) + +if USE_HTML +html_project_DATA += sfile12c.jpg bit_c.jpg +endif + +EXTRA_DIST = *.jpg *.vsd diff --git a/doc/started/started.texi b/doc/started/started.texi index b79d534752..9cfb33ee18 100644 --- a/doc/started/started.texi +++ b/doc/started/started.texi @@ -24,7 +24,7 @@ @c @c Now set all the tool version dependent information @c -@include versions.texi +@include tversions.texi @ignore @ifinfo diff --git a/doc/started/tversions.texi b/doc/started/tversions.texi new file mode 100644 index 0000000000..5b93d6a3b4 --- /dev/null +++ b/doc/started/tversions.texi @@ -0,0 +1,92 @@ +@c +@c COPYRIGHT (c) 1988-1999. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@c +@c This file contains all toolset version dependent information +@c + +@c +@c Comment out setting the "XYZ-RTEMSPATCH" variable if there is no +@c patch required. The documentation will detect this and print +@c an appropriate message in a short section. +@c + + +@c +@c GCC/EGCS Version +@c + +@set GCC-VERSION gcc 2.95.2 +@set GCC-TAR gcc-2.95.2.tar.gz +@set GCC-UNTAR gcc-2.95.2 +@set GCC-FTPSITE gcc.gnu.org +@set GCC-FTPDIR /pub/gcc/gcc-2.95.2 +@set GCC-HTTPDIR /pub/gcc/releases/index.html +@set GCC-RTEMSPATCH gcc-2.95.2-rtems-20000106.diff + +@c +@c BINUTILS Version +@c + +@c The "official" binutils +@c @set BINUTILS-VERSION binutils 2.9.1 +@c @set BINUTILS-TAR binutils-2.9.1.tar.gz +@c @set BINUTILS-UNTAR binutils-2.9.1 +@c @set BINUTILS-FTPSITE ftp.gnu.org +@c @set BINUTILS-FTPDIR /pub/gnu +@c @set BINUTILS-RTEMSPATCH binutils-2.9.1-rtems-diff-19981012.gz + +@c The "official" Linux binutils +@set BINUTILS-VERSION binutils 2.9.5.0.22 +@set BINUTILS-TAR binutils-2.9.5.0.22.tar.gz +@set BINUTILS-UNTAR binutils-2.9.5.0.22 +@set BINUTILS-FTPSITE ftp.varesearch.com +@set BINUTILS-FTPDIR /pub/support/hjl/binutils +@set BINUTILS-RTEMSPATCH binutils-2.9.5.0.22-rtems-20000114.diff + +@c When forced to use a snapshot +@c @set BINUTILS-VERSION gas 980314 +@c @set BINUTILS-TAR gas-980314.tgz +@c @set BINUTILS-UNTAR gas-980314 +@c @set BINUTILS-FTPSITE ftp.OARcorp.com +@c @set BINUTILS-FTPDIR /oarcorp/private/beta3/ada_tools +@c @set BINUTILS-RTEMSPATCH binutils-2.8.1-rtems-diff-1998xxxx.gz + +@c +@c NEWLIB Version +@c + +@set NEWLIB-VERSION newlib 1.8.2 +@set NEWLIB-TAR newlib-1.8.2.tar.gz +@set NEWLIB-UNTAR newlib-1.8.2 +@set NEWLIB-FTPSITE sourceware.cygnus.com +@set NEWLIB-FTPDIR /pub/newlib +@set NEWLIB-RTEMSPATCH newlib-1.8.2-rtems-20000104.diff + +@c +@c GDB Version +@c + +@set GDB-VERSION gdb 4.18 +@set GDB-TAR gdb-4.18.tar.gz +@set GDB-UNTAR gdb-4.18 +@set GDB-FTPSITE ftp.gnu.org +@set GDB-FTPDIR /pub/gnu/gdb +@set GDB-RTEMSPATCH gdb-4.18-rtems-20000107.diff + +@c +@c RTEMS Version +@c + +@set RTEMS-VERSION RTEMS 4.5.0-beta +@set RTEMS-TAR rtems-4.5.0-beta.tgz +@set RTEMS-UNTAR rtems-4.5.0-beta +@set RTEMS-FTPSITE ftp.OARcorp.com +@set RTEMS-FTPDIR /pub/rtems/releases/4.5.0-beta +@set BUILDTOOLS-TAR c_build_scripts-20000104.tgz + diff --git a/doc/started/versions.texi b/doc/started/versions.texi deleted file mode 100644 index 5b93d6a3b4..0000000000 --- a/doc/started/versions.texi +++ /dev/null @@ -1,92 +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 This file contains all toolset version dependent information -@c - -@c -@c Comment out setting the "XYZ-RTEMSPATCH" variable if there is no -@c patch required. The documentation will detect this and print -@c an appropriate message in a short section. -@c - - -@c -@c GCC/EGCS Version -@c - -@set GCC-VERSION gcc 2.95.2 -@set GCC-TAR gcc-2.95.2.tar.gz -@set GCC-UNTAR gcc-2.95.2 -@set GCC-FTPSITE gcc.gnu.org -@set GCC-FTPDIR /pub/gcc/gcc-2.95.2 -@set GCC-HTTPDIR /pub/gcc/releases/index.html -@set GCC-RTEMSPATCH gcc-2.95.2-rtems-20000106.diff - -@c -@c BINUTILS Version -@c - -@c The "official" binutils -@c @set BINUTILS-VERSION binutils 2.9.1 -@c @set BINUTILS-TAR binutils-2.9.1.tar.gz -@c @set BINUTILS-UNTAR binutils-2.9.1 -@c @set BINUTILS-FTPSITE ftp.gnu.org -@c @set BINUTILS-FTPDIR /pub/gnu -@c @set BINUTILS-RTEMSPATCH binutils-2.9.1-rtems-diff-19981012.gz - -@c The "official" Linux binutils -@set BINUTILS-VERSION binutils 2.9.5.0.22 -@set BINUTILS-TAR binutils-2.9.5.0.22.tar.gz -@set BINUTILS-UNTAR binutils-2.9.5.0.22 -@set BINUTILS-FTPSITE ftp.varesearch.com -@set BINUTILS-FTPDIR /pub/support/hjl/binutils -@set BINUTILS-RTEMSPATCH binutils-2.9.5.0.22-rtems-20000114.diff - -@c When forced to use a snapshot -@c @set BINUTILS-VERSION gas 980314 -@c @set BINUTILS-TAR gas-980314.tgz -@c @set BINUTILS-UNTAR gas-980314 -@c @set BINUTILS-FTPSITE ftp.OARcorp.com -@c @set BINUTILS-FTPDIR /oarcorp/private/beta3/ada_tools -@c @set BINUTILS-RTEMSPATCH binutils-2.8.1-rtems-diff-1998xxxx.gz - -@c -@c NEWLIB Version -@c - -@set NEWLIB-VERSION newlib 1.8.2 -@set NEWLIB-TAR newlib-1.8.2.tar.gz -@set NEWLIB-UNTAR newlib-1.8.2 -@set NEWLIB-FTPSITE sourceware.cygnus.com -@set NEWLIB-FTPDIR /pub/newlib -@set NEWLIB-RTEMSPATCH newlib-1.8.2-rtems-20000104.diff - -@c -@c GDB Version -@c - -@set GDB-VERSION gdb 4.18 -@set GDB-TAR gdb-4.18.tar.gz -@set GDB-UNTAR gdb-4.18 -@set GDB-FTPSITE ftp.gnu.org -@set GDB-FTPDIR /pub/gnu/gdb -@set GDB-RTEMSPATCH gdb-4.18-rtems-20000107.diff - -@c -@c RTEMS Version -@c - -@set RTEMS-VERSION RTEMS 4.5.0-beta -@set RTEMS-TAR rtems-4.5.0-beta.tgz -@set RTEMS-UNTAR rtems-4.5.0-beta -@set RTEMS-FTPSITE ftp.OARcorp.com -@set RTEMS-FTPDIR /pub/rtems/releases/4.5.0-beta -@set BUILDTOOLS-TAR c_build_scripts-20000104.tgz - -- cgit v1.2.3