summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2004-09-27 22:28:16 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2004-09-27 22:28:16 +0000
commit34ffa996302ff44dd323c957abc17a6443cdedf4 (patch)
tree08878b55f90b93a6ee48a567633dbfe670431100 /doc
parent7a965bcd6a3a03712a695541ce24eeb380754e81 (diff)
downloadrtems-34ffa996302ff44dd323c957abc17a6443cdedf4.tar.bz2
2004-09-27 Joel Sherrill <joel@OARcorp.com>
PR 681/doc PR 682/doc * buildc.t, buildrt.t, sample.t: Fix PATH and tar examples. Enable binutils link again. * user/overview.t: Chapter numbering in preface was wrong.
Diffstat (limited to '')
-rw-r--r--doc/ChangeLog8
-rw-r--r--doc/started/buildc.t5
-rw-r--r--doc/started/buildrt.t13
-rw-r--r--doc/started/sample.t2
-rw-r--r--doc/user/overview.t48
5 files changed, 44 insertions, 32 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 80d974b517..e7f845b2ec 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,11 @@
+2004-09-27 Joel Sherrill <joel@OARcorp.com>
+
+ PR 681/doc
+ PR 682/doc
+ * buildc.t, buildrt.t, sample.t: Fix PATH and tar examples. Enable
+ binutils link again.
+ * user/overview.t: Chapter numbering in preface was wrong.
+
2004-09-24 Ralf Corsepius <ralf_corsepius@rtems.org>
* configure.ac: Require automake > 1.9.
diff --git a/doc/started/buildc.t b/doc/started/buildc.t
index b4f9f808f2..8c23d49d9c 100644
--- a/doc/started/buildc.t
+++ b/doc/started/buildc.t
@@ -498,11 +498,12 @@ invoke the @value{BINUTILSUNTAR} @code{configure} command with the
@code{--help} option.
NOTE: The shell PATH variable needs to be updated to include the path
-the binutils has been installed in. This the prefix used above with
+the binutils user executables have been installed in. The directory
+containing the executables is the prefix used above with
@file{bin} post-fixed.
@example
-export PATH=$PATH:@value{RTEMSPREFIX}/bin
+export PATH=@value{RTEMSPREFIX}/bin:${PATH}
@end example
Failure to have the binutils in the path will cause the GCC and NEWLIB
diff --git a/doc/started/buildrt.t b/doc/started/buildrt.t
index 91ff840161..93df0db738 100644
--- a/doc/started/buildrt.t
+++ b/doc/started/buildrt.t
@@ -20,10 +20,7 @@ placed in your @code{archive} directory.
FTP Site: @value{RTEMSFTPSITE}
Directory: @value{RTEMSFTPDIR}/@value{VERSION}
File: @value{RTEMSTAR}
-@ifset use-html
-@c URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}, Download RTEMS components}
- URL: ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}
-@end ifset
+ URL: @uref{ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}/@value{RTEMSTAR},,ftp://@value{RTEMSFTPSITE}@value{RTEMSFTPDIR}/@value{VERSION}/@value{RTEMSTAR}}
@end example
@subheading RTEMS Examples including Hello World
@@ -54,11 +51,13 @@ This creates the directory @value{RTEMSUNTAR}.
@section Add <INSTALL_POINT>/bin to Executable PATH
In order to compile RTEMS, you must have the cross compilation toolset
-in your search path. The following command appends the directory
-where the tools were installed prior to this point:
+in your search path. It is important to have the RTEMS toolset first
+in your path to ensure that you are using the intended version of all
+tools. The following command prepends the directory
+where the tools were installed in a previous step:
@example
-export PATH=$PATH:<INSTALL_POINT>/bin
+export PATH=<INSTALL_POINT>/bin:${PATH}
@end example
NOTE: The above command is in Bourne shell (@code{sh}) syntax and
diff --git a/doc/started/sample.t b/doc/started/sample.t
index 4d34e9f709..caf6a2e6aa 100644
--- a/doc/started/sample.t
+++ b/doc/started/sample.t
@@ -210,7 +210,7 @@ applications:
@example
cd tools
-tar xzf ../archive/hello_world_ada.tgz
+tar xjf ../archive/ada-examples-@value{VERSION}.tar.bz2
@end example
@subheading Create a BSP Specific Makefile
diff --git a/doc/user/overview.t b/doc/user/overview.t
index 031fa86d31..817d0dc552 100644
--- a/doc/user/overview.t
+++ b/doc/user/overview.t
@@ -434,97 +434,101 @@ introduction to the ideas which are common across multiple RTEMS
managers.
@item Chapter 3:
+RTEMS Data Types: describes the fundamental data types shared
+by the services in the RTEMS Classic API.
+
+@item Chapter 4:
Initialization Manager: describes the functionality and directives
provided by the Initialization Manager.
-@item Chapter 4:
+@item Chapter 5:
Task Manager: describes the functionality and directives provided
by the Task Manager.
-@item Chapter 5:
+@item Chapter 6:
Interrupt Manager: describes the functionality and directives
provided by the Interrupt Manager.
-@item Chapter 6:
+@item Chapter 7:
Clock Manager: describes the functionality and directives
provided by the Clock Manager.
-@item Chapter 7
+@item Chapter 8:
Timer Manager: describes the functionality and directives provided
by the Timer Manager.
-@item Chapter 8:
+@item Chapter 9:
Semaphore Manager: describes the functionality and directives
provided by the Semaphore Manager.
-@item Chapter 9:
+@item Chapter 10:
Message Manager: describes the functionality and directives
provided by the Message Manager.
-@item Chapter 10:
+@item Chapter 11:
Event Manager: describes the
functionality and directives provided by the Event Manager.
-@item Chapter 11:
+@item Chapter 12:
Signal Manager: describes the
functionality and directives provided by the Signal Manager.
-@item Chapter 12:
+@item Chapter 13:
Partition Manager: describes the
functionality and directives provided by the Partition Manager.
-@item Chapter 13:
+@item Chapter 14:
Region Manager: describes the
functionality and directives provided by the Region Manager.
-@item Chapter 14:
+@item Chapter 15:
Dual-Ported Memory Manager: describes
the functionality and directives provided by the Dual-Ported
Memory Manager.
-@item Chapter 15:
+@item Chapter 16:
I/O Manager: describes the
functionality and directives provided by the I/O Manager.
-@item Chapter 16:
+@item Chapter 17:
Fatal Error Manager: describes the functionality and directives
provided by the Fatal Error Manager.
-@item Chapter 17:
+@item Chapter 18:
Scheduling Concepts: details the RTEMS scheduling algorithm and
task state transitions.
-@item Chapter 18:
+@item Chapter 19:
Rate Monotonic Manager: describes the functionality and directives
provided by the Rate Monotonic Manager.
-@item Chapter 19:
+@item Chapter 20:
Board Support Packages: defines the
functionality required of user-supplied board support packages.
-@item Chapter 20:
+@item Chapter 21:
User Extensions: shows the user how to
extend RTEMS to incorporate custom features.
-@item Chapter 21:
+@item Chapter 22:
Configuring a System: details the process by which one tailors RTEMS
for a particular single-processor or multiprocessor application.
-@item Chapter 22:
+@item Chapter 23:
Multiprocessing Manager: presents a
conceptual overview of the multiprocessing capabilities provided
by RTEMS as well as describing the Multiprocessing
Communications Interface Layer and Multiprocessing Manager
directives.
-@item Chapter 23:
+@item Chapter 24:
Directive Status Codes: provides a definition of each of the
directive status codes referenced in this manual.
-@item Chapter 24:
+@item Chapter 25:
Example Application: provides a template for simple RTEMS applications.
-@item Chapter 25:
+@item Chapter 26:
Glossary: defines terms used throughout this manual.
@end table