summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRalf Corsepius <ralf.corsepius@rtems.org>2003-08-30 06:11:21 +0000
committerRalf Corsepius <ralf.corsepius@rtems.org>2003-08-30 06:11:21 +0000
commita477937e0fe4c852f2476ae9fd220c69bfbe9b52 (patch)
treeaef92fc7839d9401aa3c87191699df28da3e4622 /doc
parent2003-08-30 Ralf Corsepius <corsepius@faw.uni-ulm.de> (diff)
downloadrtems-a477937e0fe4c852f2476ae9fd220c69bfbe9b52.tar.bz2
2003-08-30 Ralf Corsepius <corsepius@faw.uni-ulm.de>
* started.texi: include common/rtems.texi. * Makefile.am: Reflect changes to $(top_srcdir)/project.am. * binaries.t: Fix list of supported binary packages. Comment out references to cygwin rpms. Fix definition of RPM. Add Java to optional langs. Use RTEMSPREFIX instead of /opt/rtems. * buildc.t: Use RTEMSPREFIX instead of /opt/rtems. * buildrt.t: Various minor fixes. Use --disable-networking instead of --disable-tcpip. Use RTEMSPREFIX instead of /opt/rtems. * nextstep.t: Remove some more refs to oarcorp.com. Use RTEMSHTTPURL instead of www.rtems.com. * started/tversions.texi.in: Use @value{VERSION} instead of hard-coded "4.6.0"
Diffstat (limited to 'doc')
-rw-r--r--doc/started/ChangeLog17
-rw-r--r--doc/started/Makefile.am3
-rw-r--r--doc/started/binaries.t30
-rw-r--r--doc/started/buildc.t10
-rw-r--r--doc/started/buildrt.t11
-rw-r--r--doc/started/nextstep.t4
-rw-r--r--doc/started/started.texi1
-rw-r--r--doc/started/tversions.texi.in6
8 files changed, 50 insertions, 32 deletions
diff --git a/doc/started/ChangeLog b/doc/started/ChangeLog
index 6ce4b15873..b9143a0b5b 100644
--- a/doc/started/ChangeLog
+++ b/doc/started/ChangeLog
@@ -1,3 +1,20 @@
+2003-08-30 Ralf Corsepius <corsepius@faw.uni-ulm.de>
+
+ * started.texi: include common/rtems.texi.
+ * Makefile.am: Reflect changes to $(top_srcdir)/project.am.
+ * binaries.t: Fix list of supported binary packages.
+ Comment out references to cygwin rpms.
+ Fix definition of RPM. Add Java to optional langs.
+ Use RTEMSPREFIX instead of /opt/rtems.
+ * buildc.t: Use RTEMSPREFIX instead of /opt/rtems.
+ * buildrt.t: Various minor fixes.
+ Use --disable-networking instead of --disable-tcpip.
+ Use RTEMSPREFIX instead of /opt/rtems.
+ * nextstep.t: Remove some more refs to oarcorp.com.
+ Use RTEMSHTTPURL instead of www.rtems.com.
+ * started/tversions.texi.in: Use @value{VERSION} instead of
+ hard-coded "4.6.0"
+
2003-08-28 Ralf Corsepius <corsepiu@faw.uni-ulm.de>
* tversions.texi: Remove.
diff --git a/doc/started/Makefile.am b/doc/started/Makefile.am
index 2de11f4713..497172270b 100644
--- a/doc/started/Makefile.am
+++ b/doc/started/Makefile.am
@@ -16,8 +16,7 @@ include $(top_srcdir)/main.am
GENERATED_FILES = binaries.texi buildc.texi buildrt.texi intro.texi \
nt.texi require.texi nextstep.texi sample.texi
-COMMON_FILES = $(top_srcdir)/common/setup.texi \
- $(top_srcdir)/common/cpright.texi
+COMMON_FILES += $(top_srcdir)/common/cpright.texi
FILES =
diff --git a/doc/started/binaries.t b/doc/started/binaries.t
index 75ec2b58b4..22ce3aa1a8 100644
--- a/doc/started/binaries.t
+++ b/doc/started/binaries.t
@@ -12,17 +12,17 @@ Precompiled toolsets are available for Linux, Cygwin, FreeBSD,
and Solaris. These are packaged in the following formats:
@itemize @bullet
-@item Linux - RPM and Debian
-@item Cygwin - RPM and zipped tar
-@item FreeBSD - native package
-@item Solaris - RPM and zipped tar
+@item Linux - RPM
+@item Cygwin - tar.bz2
+@item Solaris - tar.bz2
@end itemize
-RPM is an acronym for the RedHat Package Manager. RPM is the
+RPM is an acronym for the RPM Package Manager. RPM is the
native package installer for many Linux distributions including
-RedHat and SuSE. RPM supports other operating systems including
-Cygwin. @uref{mailto:D.J@@fiddes.surfaid.org,David Fiddes <D.J@@fiddes.surfaid.org>}
-did the initial groundwork that lead to Cygwin RPMs being available.
+RedHat and SuSE.
+@c RPM supports other operating systems including
+@c Cygwin. @uref{mailto:D.J@@fiddes.surfaid.org,David Fiddes <D.J@@fiddes.surfaid.org>}
+@c did the initial groundwork that lead to Cygwin RPMs being available.
The prebuilt binaries are intended to be easy to install and
the instructions are similar regardless of the host environment.
@@ -39,8 +39,8 @@ across all target architectures. These are referred to as
"base" packages.
@item If buildable for a particular CPU, RPMs are provided for
-Chill, Java (gcj), Fortran (g77), and Objective-C (objc). These
-binaries are strictly optional.
+Ada (gnat), Chill, Java (gcj), Fortran (g77), and Objective-C (objc).
+These binaries are strictly optional.
@end enumerate
@@ -68,8 +68,8 @@ rpm -i sparc-rtems-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.i386.rpm
Upon successful completion of the above command sequence, a
C/C++ cross development toolset targeting the SPARC is
-installed in @code{/opt/rtems}. In order to use this toolset,
-the directory @code{/opt/rtems/bin} must be included in your
+installed in @code{@value{RTEMSPREFIX}}. In order to use this toolset,
+the directory @code{@value{RTEMSPREFIX}/bin} must be included in your
PATH.
Once you have successfully installed the RPMs for BINUTILS, GCC,
@@ -124,14 +124,14 @@ tar xzf sparc-rtems-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tgz
Upon successful completion of the above command sequence, a
C/C++ cross development toolset targeting the SPARC is
-installed in @code{/opt/rtems}. In order to use this toolset,
-the directory @code{/opt/rtems/bin} must be included in your
+installed in @code{@value{RTEMSPREFIX}}. In order to use this toolset,
+the directory @code{@value{RTEMSPREFIX}} must be included in your
PATH.
@subsection Removing Zipped Tar Files
There is no automatic way to remove the contents of a @code{tgz} once
-it is installed. The contents of the directory @code{/opt/rtems}
+it is installed. The contents of the directory @code{@value{RTEMSPREFIX}}
can be removed but this will likely result in other packages
being removed as well.
diff --git a/doc/started/buildc.t b/doc/started/buildc.t
index 0329d43d67..08d2ce152f 100644
--- a/doc/started/buildc.t
+++ b/doc/started/buildc.t
@@ -426,7 +426,7 @@ the required source is installed.
cd <RPM_ROOT_DIRECTORY>/RPMS/i386
rpm -i rtems-base-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.i386.rpm
rpm -i i386-rtems-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.i386.rpm
-export PATH=/opt/rtems/bin:$PATH
+export PATH=@value{RTEMSPREFIX}/bin:$PATH
cd <RPM_ROOT_DIRECTORY>/SPECS
rpm -bb i386-rtems-gcc-@value{GCCVERSION}-newlib-@value{NEWLIBVERSION}.spec
@end example
@@ -485,7 +485,7 @@ sparc-rtems target:
mkdir b-binutils
cd b-binutils
../@value{BINUTILSUNTAR}/configure --target=sparc-rtems \
- --prefix=/opt/rtems
+ --prefix=@value{RTEMSPREFIX}
make all
make info
make install
@@ -504,7 +504,7 @@ the binutils has been installed in. This the prefix used above with
@file{bin} post-fixed.
@example
-export PATH=$PATH:/opt/rtems/bin
+export PATH=$PATH:@value{RTEMSPREFIX}/bin
@end example
Failure to have the binutils in the path will cause the GCC and NEWLIB
@@ -545,7 +545,7 @@ mkdir b-gcc
cd b-gcc
../@value{GCCUNTAR}/configure --target=sparc-rtems \
--with-gnu-as --with-gnu-ld --with-newlib --verbose \
- --enable-threads --prefix=/opt/rtems
+ --enable-threads --prefix=@value{RTEMSPREFIX}
make all
make info
make install
@@ -785,7 +785,7 @@ m68k-rtems target:
mkdir b-gdb
cd b-gdb
../@value{GDBUNTAR}/configure --target=m68k-rtems \
- --prefix=/opt/rtems
+ --prefix=@value{RTEMSPREFIX}
make all
make info
make install
diff --git a/doc/started/buildrt.t b/doc/started/buildrt.t
index 6a1902db6a..565427c738 100644
--- a/doc/started/buildrt.t
+++ b/doc/started/buildrt.t
@@ -131,10 +131,12 @@ This section describes how to build RTEMS.
@subsection Using the RTEMS configure Script Directly
Make a build directory under tools and build the RTEMS product in this
-directory. The ../@value{RTEMSUNTAR}/configure
+directory. The @code{../@value{RTEMSUNTAR}/configure}
command has numerous command line
arguments. These arguments are discussed in detail in documentation that
-comes with the RTEMS distribution. If you followed the procedure
+comes with the RTEMS distribution. A full list of these arguments can be
+obtained by running @code{../@value{RTEMSUNTAR}/configure --help}
+If you followed the procedure
described in the section @ref{Unarchive the RTEMS Source}, these
configuration options can be found in the file
tools/@value{RTEMSUNTAR}/README.configure.
@@ -152,7 +154,7 @@ the @code{BOARD_SUPPORT_PACKAGE} board.
mkdir build-rtems
cd build-rtems
../@value{RTEMSUNTAR}/configure --target=<TARGET_CONFIGURATION> \
- --disable-posix --disable-tcpip --disable-cxx \
+ --disable-posix --disable-networking --disable-cxx \
--enable-rtemsbsp=<BOARD_SUPPORT_PACKAGE>\
--prefix=<INSTALL_POINT>
make all install
@@ -163,7 +165,7 @@ Where the list of currently supported <TARGET_CONFIGURATION>'s and
tools/@value{RTEMSUNTAR}/README.configure.
<INSTALL_POINT> is typically the installation point for the
-tools and is @code{/opt/rtems} when using prebuilt toolset executables.
+tools and defaults to @code{@value{RTEMSPREFIX}}.
BSP is a supported BSP for the selected CPU family. The list of
supported BSPs may be found in the file
@@ -174,4 +176,3 @@ then all supported BSPs for the selected CPU family will be built.
@b{NOTE:} The POSIX API must be enabled to use GNAT/RTEMS.
@b{NOTE:} The @code{make} utility used should be GNU make.
-
diff --git a/doc/started/nextstep.t b/doc/started/nextstep.t
index 248728ba26..c8cf5e24aa 100644
--- a/doc/started/nextstep.t
+++ b/doc/started/nextstep.t
@@ -66,7 +66,7 @@ C Math Library functionality provided by Newlib's libm.
@end itemize
Finally, the RTEMS FAQ and mailing list archives are available
-at @uref{http://www.oarcorp.com}.
+at @uref{@value{RTEMSHTTPURL}}.
There is a wealth of documentation available for RTEMS and
the GNU tools supporting it. If you run into something
@@ -79,7 +79,7 @@ effort, please contact the RTEMS Team at
If you are interested in sponsoring the development of a new
feature, BSP, device driver, port of an existing library, etc.,
please contact one of the RTEMS Service Providers listed
-at @uref{http://www.rtems.com/support.html}.
+at @uref{@value{RTEMSHTTPURL}/support.html,@value{RTEMSHTTPURL}/support.html}.
@section Writing an Application
diff --git a/doc/started/started.texi b/doc/started/started.texi
index 702d4e3e70..334cd1a75a 100644
--- a/doc/started/started.texi
+++ b/doc/started/started.texi
@@ -21,6 +21,7 @@
@include version.texi
@include common/setup.texi
+@include common/rtems.texi
@c
@c Now set all the tool version dependent information
diff --git a/doc/started/tversions.texi.in b/doc/started/tversions.texi.in
index be3a670e04..df297d1f1d 100644
--- a/doc/started/tversions.texi.in
+++ b/doc/started/tversions.texi.in
@@ -84,8 +84,8 @@
@c RTEMS Version
@c
-@set RTEMSVERSION RTEMS 4.6.0
-@set RTEMSUNTAR rtems-4.6.0
+@set RTEMSVERSION RTEMS @value{VERSION}
+@set RTEMSUNTAR rtems-@value{VERSION}
@set RTEMSTAR @value{RTEMSUNTAR}.tar.bz2
@set RTEMSFTPSITE ftp.rtems.com
-@set RTEMSFTPDIR /pub/rtems/releases/4.6.0
+@set RTEMSFTPDIR /pub/rtems/releases/@value{VERSION}