diff --git a/doc/ChangeLog b/doc/ChangeLog index 8b4e128383..16e9dfc5f2 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,15 @@ +2004-02-03 Joel Sherrill + + * HELP.html, index.html.in, rtems_footer.html.in, rtems_header.html.in, + rtems_support.html.in, FAQ/basic.t, gnu_docs/gnu_footer.html, + gnu_docs/index.html, gnu_docs/refcard.html, + gnu_docs/rtems_tools_index.html, started/binaries.t, + started/buildc.t, started/buildrt.t, started/intro.t, + started/require.t, started/sample.t, started/tversions.texi.in: + Attempt to make the documentation more accurately reflect the state + of the world. These changes were primarily concerned with server + layout. + 2004-02-01 Ralf Corsepius * configure.ac: Add RTEMSRPMGROUP. diff --git a/doc/FAQ/basic.t b/doc/FAQ/basic.t index 70ab8af089..66311e8844 100644 --- a/doc/FAQ/basic.t +++ b/doc/FAQ/basic.t @@ -152,7 +152,7 @@ Yes, but not all are based on standards and the open source philosophy. RTEMS is distributed from @uref{@value{RTEMSHTTPURL},@value{RTEMSHTTPURL}}. This is a server dedicated to the RTEMS Project which was donated by and -hosted by @uref{http://www.OARcorp.com,OAR Corporation} to provide +hosted by @uref{http://www.oarcorp.com,OAR Corporation} to provide a focal point for all RTEMS activities. Point your favorite browser at the following URL and following the link: @@ -179,7 +179,7 @@ message to @code{@value{RTEMSUSERSSUBSCRIBE}}. This mailing list is archived at: @example -http://www.oarcorp.com/rtems/maillistArchives/rtems-users +http://www.rtems.com/ml/rtems-users @end example The @code{@value{RTEMSSNAPSHOTS}} mailing list is for those @@ -191,7 +191,7 @@ message to @code{@value{RTEMSSNAPSHOTSSUBSCRIBE}}. mailing list is archived at: @example -http://www.oarcorp.com/rtems/maillistArchives/rtems-snapshots +http://www.rtems.com/ml/rtems-snapshots @end example The archives for both mailing lists include discussions back diff --git a/doc/HELP.html b/doc/HELP.html index c49935bbf3..45ac1d796f 100644 --- a/doc/HELP.html +++ b/doc/HELP.html @@ -18,5 +18,5 @@ want to contribute to RTEMS, please contact a member of the RTEMS Steering Committee.

-Copyright © 1988-2003 OAR Corporation +Copyright © 1988-2004 OAR Corporation diff --git a/doc/gnu_docs/gnu_footer.html b/doc/gnu_docs/gnu_footer.html index bd79cba476..81b9b63194 100644 --- a/doc/gnu_docs/gnu_footer.html +++ b/doc/gnu_docs/gnu_footer.html @@ -1,2 +1 @@ -

Packaging copyright © 1988-2003 OAR Corporation
-Content copyright by each document's author. See Free Software Foundation for information. +

Each document is copyright by its author(s). See Free Software Foundation for information. diff --git a/doc/gnu_docs/index.html b/doc/gnu_docs/index.html index ce0fce8578..f044d867ad 100644 --- a/doc/gnu_docs/index.html +++ b/doc/gnu_docs/index.html @@ -139,5 +139,5 @@

-Copyright © 1988-2003 OAR Corporation +Copyright © 1988-2004 OAR Corporation diff --git a/doc/gnu_docs/refcard.html b/doc/gnu_docs/refcard.html index 8f368e6f28..5001ec7c88 100644 --- a/doc/gnu_docs/refcard.html +++ b/doc/gnu_docs/refcard.html @@ -9,5 +9,5 @@ The GDB Reference card is not written in texinfo file. There is currently no HTML or PDF version of this file.
-Copyright © 1988-2003 OAR Corporation +Copyright © 1988-2004 OAR Corporation diff --git a/doc/gnu_docs/rtems_tools_index.html b/doc/gnu_docs/rtems_tools_index.html index b92725551f..92ddd2b1b8 100644 --- a/doc/gnu_docs/rtems_tools_index.html +++ b/doc/gnu_docs/rtems_tools_index.html @@ -11,5 +11,5 @@
  • GNU Documentation
    • -Copyright © 1988-2003 OAR Corporation +Copyright © 1988-2004 OAR Corporation diff --git a/doc/index.html.in b/doc/index.html.in index 1d01fbf9c0..eec464c660 100644 --- a/doc/index.html.in +++ b/doc/index.html.in @@ -298,5 +298,5 @@
    -Copyright © 1988-2003 OAR Corporation +Copyright © 1988-2004 OAR Corporation diff --git a/doc/rtems_footer.html.in b/doc/rtems_footer.html.in index 37ed56c17b..620704503a 100644 --- a/doc/rtems_footer.html.in +++ b/doc/rtems_footer.html.in @@ -1 +1 @@ -

    Copyright © 1988-2003 OAR Corporation +

    Copyright © 1988-2004 OAR Corporation diff --git a/doc/rtems_header.html.in b/doc/rtems_header.html.in index 97c89d52b9..e3230eac83 100644 --- a/doc/rtems_header.html.in +++ b/doc/rtems_header.html.in @@ -1,5 +1,5 @@ - RTEMS Logo + RTEMS Logo

    RTEMS @VERSION@ On-Line Library

    diff --git a/doc/rtems_support.html.in b/doc/rtems_support.html.in index fb4bc026d5..c053ea7b59 100644 --- a/doc/rtems_support.html.in +++ b/doc/rtems_support.html.in @@ -1,7 +1,7 @@ RTEMS @VERSION@ On-Line Library - + RTEMS Logo

    RTEMS RTEMS_VERSION On-Line Library

    @@ -55,5 +55,5 @@ RTEMS LogoMENU>
    -Copyright © 1988-2003 OAR Corporation +Copyright © 1988-2004 OAR Corporation diff --git a/doc/started/binaries.t b/doc/started/binaries.t index 2f5b4ea303..9b53a9765f 100644 --- a/doc/started/binaries.t +++ b/doc/started/binaries.t @@ -19,10 +19,7 @@ and Solaris. These are packaged in the following formats: RPM is an acronym for the RPM Package Manager. RPM is the native package installer for many Linux distributions including -RedHat and SuSE. -@c RPM supports other operating systems including -@c Cygwin. @uref{mailto:D.J@@fiddes.surfaid.org,David Fiddes } -@c did the initial groundwork that lead to Cygwin RPMs being available. +RedHat, SuSE, and Fedora. The prebuilt binaries are intended to be easy to install and the instructions are similar regardless of the host environment. @@ -38,9 +35,10 @@ Some packaging formats enforce this dependency. across all target architectures. These are referred to as "base" packages. -@item If buildable for a particular CPU, RPMs are provided for -Ada (gnat), Chill, Java (gcj), Fortran (g77), and Objective-C (objc). -These binaries are strictly optional. +@item Depending upon the version of GCC as well as the development +host and target CPU combination, pre-built supplemental packages may +be provided for Ada (gnat), Chill, Java (gcj), Fortran (g77), and +Objective-C (objc). These binaries are strictly optional. @end enumerate @@ -106,22 +104,37 @@ RPM will complain about not being able to remove everything. @section Zipped Tar Files This section provides information on installing and removing -Zipped Tar Files (.tgz). +Zipped Tar Files (e.g .tar.gz or .tar.bz2). @subsection Installing Zipped Tar Files The following is a sample session illustrating the installation of a C/C++ toolset targeting the SPARC architecture assuming -that GNU tar is installed as @code{tar}: +that GNU tar is installed as @code{tar} for a set of archive +files compressed with GNU Zip (gzip): @example cd / -tar xzf rtems-base-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.tgz -tar xzf sparc-rtems-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.tgz -tar xzf rtems-base-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.tgz -tar xzf sparc-rtems-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.tgz -tar xzf rtems-base-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tgz -tar xzf sparc-rtems-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tgz +tar xzf @value{RTEMSRPMPREFIX}rtems-base-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.tar.gz +tar xzf @value{RTEMSRPMPREFIX}sparc-rtems-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.tar.gz +tar xzf @value{RTEMSRPMPREFIX}rtems-base-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.tar.gz +tar xzf @value{RTEMSRPMPREFIX}sparc-rtems-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.tar.gz +tar xzf @value{RTEMSRPMPREFIX}rtems-base-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tar.gz +tar xzf @value{RTEMSRPMPREFIX}sparc-rtems-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tar.gz +@end example + +The following command set is the equivalent command sequence +for the same toolset assuming that is was compressed with +GNU BZip (bzip2): + +@example +cd / +tar xjf @value{RTEMSRPMPREFIX}rtems-base-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.tar.bz2 +tar xjf @value{RTEMSRPMPREFIX}sparc-rtems-binutils-@value{BINUTILSVERSION}-@value{BINUTILSRPMRELEASE}.tar.bz2 +tar xjf @value{RTEMSRPMPREFIX}rtems-base-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.tar.bz2 +tar xjf @value{RTEMSRPMPREFIX}sparc-rtems-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.tar.bz2 +tar xjf @value{RTEMSRPMPREFIX}rtems-base-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tar.bz2 +tar xjf @value{RTEMSRPMPREFIX}sparc-rtems-gdb-@value{GDBVERSION}-@value{GDBRPMRELEASE}.tar.bz2 @end example Upon successful completion of the above command sequence, a @@ -132,9 +145,9 @@ 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{@value{RTEMSPREFIX}} -can be removed but this will likely result in other packages -being removed as well. +There is no automatic way to remove the contents of a @code{tar.gz} +or @code{tar.bz2} once 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 6eb92bef81..035fbe35cb 100644 --- a/doc/started/buildc.t +++ b/doc/started/buildc.t @@ -92,7 +92,7 @@ of each component as well as any required RTEMS specific patches. @subheading RTEMS Specific Tool Patches and Scripts @example FTP Site: @value{RTEMSFTPSITE} - Directory: @value{RTEMSFTPDIR}/c_tools/source + Directory: @value{RTEMSFTPDIR}/@value{VERSION} @ifset BINUTILSPATCHVERSION File: @value{BINUTILSRTEMSPATCH} @end ifset @@ -103,8 +103,8 @@ of each component as well as any required RTEMS specific patches. File: @value{GCCRTEMSPATCH} @end ifset @ifset use-html -@c URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/c_tools/source,Download RTEMS Patches and Scripts} - URL: ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/c_tools/source +@c URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/SOURCES,Download RTEMS Patches and Scripts} + URL: ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/SOURCES @end ifset @end example @@ -437,11 +437,9 @@ of the RPMS directory under the RPM root directory. @example @value{RTEMSRPMPREFIX}rtems-base-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm -@value{RTEMSRPMPREFIX}rtems-base-chill-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @value{RTEMSRPMPREFIX}rtems-base-g77-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @value{RTEMSRPMPREFIX}rtems-base-gcj-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @value{RTEMSRPMPREFIX}i386-rtems-gcc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm -@value{RTEMSRPMPREFIX}i386-rtems-chill-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @value{RTEMSRPMPREFIX}i386-rtems-g77-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @value{RTEMSRPMPREFIX}i386-rtems-gcj-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @value{RTEMSRPMPREFIX}i386-rtems-objc-gcc@value{GCCVERSION}newlib@value{NEWLIBVERSION}-@value{GCCRPMRELEASE}.i386.rpm @@ -667,10 +665,10 @@ of each component as well as any required RTEMS specific patches. @subheading RTEMS Specific Tool Patches and Scripts @example FTP Site: @value{RTEMSFTPSITE} - Directory: @value{RTEMSFTPDIR}/c_tools/source + Directory: @value{RTEMSFTPDIR}/SOURCES @ifset GDBPATCHVERSION File: @value{GDBRTEMSPATCH} - URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/c_tools/source/@value{GDBRTEMSPATCH},,ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/c_tools/source/@value{GDBRTEMSPATCH}} + URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/SOURCES/@value{GDBRTEMSPATCH},,ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/SOURCES/@value{GDBRTEMSPATCH}} @end ifset @end example diff --git a/doc/started/buildrt.t b/doc/started/buildrt.t index 565427c738..ca3269fee0 100644 --- a/doc/started/buildrt.t +++ b/doc/started/buildrt.t @@ -18,20 +18,20 @@ placed in your @code{archive} directory. @subheading @value{RTEMSVERSION} @example FTP Site: @value{RTEMSFTPSITE} - Directory: @value{RTEMSFTPDIR} + Directory: @value{RTEMSFTPDIR}/@value{VERSION} File: @value{RTEMSTAR} @ifset use-html -@c URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}, Download RTEMS components} - URL: ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR} +@c URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}, Download RTEMS components} + URL: ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION} @end ifset @end example -@subheading RTEMS Hello World +@subheading RTEMS Examples including Hello World @example FTP Site: @value{RTEMSFTPSITE} - Directory: @value{RTEMSFTPDIR} - File: hello_world_c.tgz - URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/hello_world_c.tgz,,ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/hello_world_c.tgz} + Directory: @value{RTEMSFTPDIR}/@value{VERSION} + File: examples-@value{VERSION}.tar.bz2 + URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}/examples-@value{VERSION}.tar.bz2,,ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}/examples-@value{VERSION}.tar.bz2} @end example @c diff --git a/doc/started/intro.t b/doc/started/intro.t index 4572cdeb67..5de079a61e 100644 --- a/doc/started/intro.t +++ b/doc/started/intro.t @@ -137,8 +137,7 @@ It is in the reader's and tool maintainers' interest that one read the documentation before posting a problem to a mailing list or news group. The RTEMS Project provides formatted documentation for the primary tools in the cross development toolset including BINUTILS, GCC, -NEWLIB, and GDB at -@uref{http://www.oarcorp.com/rtemsdoc-4.5.0, http://www.oarcorp.com/rtemsdoc-4.5.0}. +NEWLIB, and GDB with the pre-built versions of those tools. Much of the documentation is available at other sites on the Internet. The following is a list of URLs where one can find HTML versions of @@ -147,7 +146,8 @@ the GNU manuals: @table @b @item Free Software Foundation -@uref{http://www.gnu.org/manual/manual.html, http://www.gnu.org/manual/manual.html} +@uref{http://www.gnu.org/manual/manual.html, +http://www.gnu.org/manual/manual.html} @item Delorie Software @uref{http://www.delorie.com/gnu/docs, http://www.delorie.com/gnu/docs} @@ -177,9 +177,8 @@ focus on embedded issues. Information on subscribing to this mailing list is included in the @uref{http://www.objsw.com/CrossGCC/,CrossGCC FAQ}. -The CrossGCC FAQ as well as a number of patches and utilities -of interest to cross development system users are available -at @uref{ftp://ftp.cygnus.com/pub/embedded/crossgcc}. +The CrossGCC FAQ and Wiki are are available +at @uref{http://www.billgatliff.com,http://www.billgatliff.com}. @subsection GCC Mailing Lists diff --git a/doc/started/require.t b/doc/started/require.t index 179bde4231..5f148f21b3 100644 --- a/doc/started/require.t +++ b/doc/started/require.t @@ -21,9 +21,9 @@ assessing the amount of disk space required for your installation: +------------------------------------+--------------------------+ | Component | Disk Space Required | +------------------------------------+--------------------------+ -| archive directory | 35 Mbytes | -| tools src unarchived | 150 Mbytes | -| each individual build directory | up to 500 Mbytes | +| archive directory | 55 Mbytes | +| tools src unarchived | 350 Mbytes | +| each individual build directory | up to 750 Mbytes | | each installation directory | 20-200 Mbytes | +------------------------------------+--------------------------+ @end example @@ -184,7 +184,8 @@ next section. When no packaging format requirements are present, the root directory for the storage of source archives and patches as well as for building the tools is up to the user. The only concern is that there be enough -disk space to complete the build. +disk space to complete the build. In this document, the following +organization will be used. Make an @code{archive} directory to contain the downloaded source code and a @code{tools} directory to be used as a build diff --git a/doc/started/sample.t b/doc/started/sample.t index b18a9d53dd..4d34e9f709 100644 --- a/doc/started/sample.t +++ b/doc/started/sample.t @@ -257,15 +257,14 @@ tools/hello_world_ada/o-optimize/.exe How this executable is downloaded to the target board is very dependent on the BOARD_SUPPORT_PACKAGE selected. ----------------------------------------------------- @c @c More Information on RTEMS Application Makefiles @c @section More Information on RTEMS Application Makefiles -The hello world sample application is a simple example of an -RTEMS application that uses the RTEMS Application Makefile +These sample applications are examples of simple +RTEMS applications that use the RTEMS Application Makefile system. This Makefile system simplifies building RTEMS applications by providing Makefile templates and capturing the configuration information used to build diff --git a/doc/started/tversions.texi.in b/doc/started/tversions.texi.in index df297d1f1d..aae618c1e2 100644 --- a/doc/started/tversions.texi.in +++ b/doc/started/tversions.texi.in @@ -88,4 +88,4 @@ @set RTEMSUNTAR rtems-@value{VERSION} @set RTEMSTAR @value{RTEMSUNTAR}.tar.bz2 @set RTEMSFTPSITE ftp.rtems.com -@set RTEMSFTPDIR /pub/rtems/releases/@value{VERSION} +@set RTEMSFTPDIR /pub/rtems