summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-04-11 14:54:58 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-04-11 14:54:58 +0000
commit57a736ffcb9f106d78f91b70705fcf21adf6c284 (patch)
treea31e8fc290777d92fefe873e12a9c1447f43fac1
parent6d3d425dbd239fdb9a65a2a0a9834db8a657346c (diff)
downloadrtems-57a736ffcb9f106d78f91b70705fcf21adf6c284.tar.bz2
Mostly correcting case of section headings although a few minor things
were corrected as the Getting Started with GNAT/RTEMS manual was created.
-rw-r--r--doc/started/Makefile6
-rw-r--r--doc/started/buildc.t12
-rw-r--r--doc/started/buildrt.t10
-rw-r--r--doc/started/gdb.t24
-rw-r--r--doc/started/sample.t12
5 files changed, 32 insertions, 32 deletions
diff --git a/doc/started/Makefile b/doc/started/Makefile
index 033c2bd62f..1e317f7b0e 100644
--- a/doc/started/Makefile
+++ b/doc/started/Makefile
@@ -50,7 +50,7 @@ intro.texi: intro.t versions.texi
-n "Requirements" ${*}.t
require.texi: require.t versions.texi
- $(BMENU) -c -p "Introduction" \
+ $(BMENU) -c -p "Cross Development" \
-u "Top" \
-n "Building the GNU C/C++ Cross Compiler Toolset" ${*}.t
@@ -65,12 +65,12 @@ buildrt.texi: buildrt.t versions.texi
-n "Building the Sample Application" ${*}.t
sample.texi: sample.t versions.texi
- $(BMENU) -c -p "Generate RTEMS for a specific target and board support package" \
+ $(BMENU) -c -p "Generate RTEMS for a Specific Target and Board Support Package" \
-u "Top" \
-n "Building the GNU Debugger" ${*}.t
gdb.texi: gdb.t versions.texi
- $(BMENU) -c -p "Application executable" \
+ $(BMENU) -c -p "Application Executable" \
-u "Top" \
-n "" ${*}.t
diff --git a/doc/started/buildc.t b/doc/started/buildc.t
index a078985e0f..a870d548c1 100644
--- a/doc/started/buildc.t
+++ b/doc/started/buildc.t
@@ -13,13 +13,15 @@ source code for a GNU cross compiler toolset, apply
any required RTEMS specific patches, compile that
toolset and install it.
-@section Get all the pieces
+@section Directory Organization
The tree structure in the figure below is assumed to be present in the
following discussions:
@center @b{XXX directory tree figure goes here}
+@section Get All the Pieces
+
Gather the components that will be required for the installation and place
them in an archive directory. Call this directory arc. Be sure that there
is sufficient space to hold all necessary information. This will amount to
@@ -52,14 +54,20 @@ approximately 20 megabytes.
Directory: @value{RTEMS-FTPDIR}
File: @value{RTEMS-TAR}
File: bit
+@ifset BINUTILS-RTEMSPATCH
File: @value{BINUTILS-RTEMSPATCH}
+@end ifset
+@ifset NEWLIB-RTEMSPATCH
File: @value{NEWLIB-RTEMSPATCH}
+@end ifset
+@ifset GCC-RTEMSPATCH
File: @value{GCC-RTEMSPATCH}
+@end ifset
File: hello_world_c.tgz
@end example
-@section Create the tools directory
+@section Create the tools Directory
Create a directory called tools that will serve as a working directory to
perform the build of the cross compiler tools.
diff --git a/doc/started/buildrt.t b/doc/started/buildrt.t
index daaf72f88b..766da50886 100644
--- a/doc/started/buildrt.t
+++ b/doc/started/buildrt.t
@@ -9,7 +9,7 @@
@chapter Building RTEMS
-@section Unpack the RTEMS source
+@section Unpack the RTEMS Source
Use the following command sequence to unpack the RTEMS source into the
tools directory:
@@ -19,7 +19,7 @@ cd tools
tar xzf ../arc/@value{RTEMS-TAR}
@end example
-@section Add the bin directory under the install point to the default PATH
+@section Add <INSTALL_POINT>/bin to Executable PATH
In order to compile RTEMS, you must have the cross compilation toolset
in your search patch. The following command appends the directory
@@ -33,7 +33,7 @@ NOTE: The above command is in Bourne shell (@code{sh}) syntax and should work w
the Korn (@code{ksh}) and GNU Bourne Again Shell (@code{bash}). It will not
work with the C Shell (@code{csh})or derivatives of the C Shell.
-@section Generate RTEMS for a specific target and board support package
+@section Generate RTEMS for a Specific Target and BSP
Make a build directory under tools and build the RTEMS product in this
directory. The ../@value{RTEMS-UNTAR}/configure
@@ -58,9 +58,7 @@ cd build-rtems
gmake all install
@end example
-Where:
-
-The list of currently supported of <TARGET_CONFIGURATION>'s and
+Where the list of currently supported of <TARGET_CONFIGURATION>'s and
<BOARD_SUPPORT_PACKAGE>'s can be found in
tools/@value{RTEMS-UNTAR}/README.configure.
diff --git a/doc/started/gdb.t b/doc/started/gdb.t
index 7ae7c2d9cd..753be10c87 100644
--- a/doc/started/gdb.t
+++ b/doc/started/gdb.t
@@ -20,7 +20,7 @@ successfully used with RTEMS applications:
Other configurations of gdb have successfully been used by RTEMS users
but are not documented here.
-@section Unarchive the gdb distribution
+@section Unarchive the gdb Distribution
Use the following commands to unarchive the gdb distribution:
@@ -76,7 +76,7 @@ The files that are found, have been modified by the patch file.
@section GDB with Sparc Instruction Simulation (SIS)
-@subheading Make the build directory
+@subheading Make the Build Directory
Create a build directory for the SIS Debugger
@@ -85,7 +85,7 @@ cd tools
mkdir build-sis
@end example
-@subheading Configure for the build
+@subheading Configure for the Build
Configure the GNU Debugger for the
Sparc Instruction Simulator (SIS):
@@ -102,7 +102,7 @@ cd tools/build-sis
Where <INSTALL_POINT_FOR_SIS> is a unique location where the gdb
with SIS will be created.
-@subheading Make the debugger
+@subheading Make the Debugger
From tools/build-sis execute the following command sequence:
@@ -113,7 +113,7 @@ gmake all install
@section GDB with PowerPC Instruction Simulator
-@subheading Make the build directory
+@subheading Make the Build Directory
Create a build directory for the SIS Debugger
@@ -122,7 +122,7 @@ cd tools
mkdir build-ppc
@end example
-@subheading Configure for the build
+@subheading Configure for the Build
Configure the GNU Debugger for the PowerPC
Instruction Simulator (PSIM):
@@ -144,7 +144,7 @@ Where <INSTALL_POINT_FOR_PPC> is a unique location where the gdb
with PSIM will be created.
-@subheading Make the debugger
+@subheading Make the Debugger
From tools/build-ppc execute the following command sequence:
@@ -155,11 +155,7 @@ gmake all install
@section GDB for DINK32
-@subheading Unarchive the gdb distribution
-
-Use the following commands to unarchive the gdb distribution:
-
-@subheading Make the build directory
+@subheading Make the Build Directory
Create a build directory for the DINK32 Debugger
@@ -168,7 +164,7 @@ cd tools
mkdir build-dink32
@end example
-@subheading Configure for the build
+@subheading Configure for the Build
Configure the GNU Debugger to communicate with
the DINK32 ROM monitor:
@@ -184,7 +180,7 @@ cd tools/build-dink32
Where <INSTALL_POINT_FOR_DINK32> is a unique location where the
gdb Dink32 will be created.
-@subheading Make the debugger
+@subheading Make the Debugger
From tools/build-dink32 execute the following command sequence:
diff --git a/doc/started/sample.t b/doc/started/sample.t
index 2ff35bda63..e7bfebc0d2 100644
--- a/doc/started/sample.t
+++ b/doc/started/sample.t
@@ -8,7 +8,7 @@
@chapter Building the Sample Application
-@section Unpack the sample application
+@section Unpack the Sample Application
Use the following command to unarchive the sample application:
@@ -17,7 +17,7 @@ cd tools
tar xzf ../arc/hello_world_c.tgz
@end example
-@section Set the environment variable RTEMS_MAKEFILE_PATH
+@section Set the Environment Variable RTEMS_MAKEFILE_PATH
It must point to the appropriate directory containing RTEMS build for our
target and board support package combination.
@@ -27,9 +27,7 @@ export RTEMS_MAKEFILE_PATH = \
<INSTALLATION_POINT>/rtems/<BOARD_SUPPORT_PACKAGE>
@end example
-Where:
-
-<INSTALLATION_POINT> and <BOARD_SUPPORT_PACKAGE> are those used when
+Where <INSTALLATION_POINT> and <BOARD_SUPPORT_PACKAGE> are those used when
configuring and installing RTEMS.
@section Build the Sample Application
@@ -46,13 +44,13 @@ reasonable to assume that the build of the GNU C/C++ Cross Compiler Tools
for RTEMS and RTEMS itself for the selected host and target
combination was done properly.
-@section Application executable
+@section Application Executable
If the sample application has successfully been build, then the application
executable is placed in the following directory:
@example
-tools/simple_app/o-<BOARD_SUPPORT_PACKAGE>/<filename>.exe
+tools/hello_world_c/o-<BOARD_SUPPORT_PACKAGE>/<filename>.exe
@end example
How this executable is downloaded to the target board is very dependent