Changeset 6113b3a in rtems


Ignore:
Timestamp:
Apr 9, 1998, 7:43:18 PM (22 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
9c2b087
Parents:
417fcc73
Message:

Now builds clean for info, html, and ps.

Location:
doc/started
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • doc/started/Makefile

    r417fcc73 r6113b3a  
    6161
    6262buildrt.texi: buildrt.t
    63         $(BMENU) -c -p "Running the bit script" \
     63        $(BMENU) -c -p "GNU C/C++ cross compiler toolset complete" \
    6464            -u "Top" \
    6565            -n "Building the Sample Application" ${*}.t
  • doc/started/buildc.t

    r417fcc73 r6113b3a  
    1 @c
    21@c
    32@c  COPYRIGHT (c) 1988-1998.
     
    87@c
    98
    10 @chapter Building RTEMS
    11 
    12 @section Unpack the RTEMS source
    13 
    14 Use the following command sequence to unpack the RTEMS source into the
    15 tools directory:
     9@chapter Building the GNU C/C++ Cross Compiler Toolset
     10
     11@section Get all the pieces
     12
     13The tree structure in the figure below is assumed to be present in the
     14following discussions:
     15
     16Gather the components that will be required for the installation and place
     17them in an archive directory. Call this directory arc. Be sure that there
     18is sufficient space to hold all necessary information. This will amount to
     19approximately 20 megabytes.
     20
     21@example
     22egcs 1.0.2
     23    FTP Site:    egcs.cygnus.com
     24    Directory:   /pub/egcs/releases/egcs-1.0.2
     25    File:        egcs-1.0.2-980309-prerelease.tar.gz
     26
     27binutils 2.8.1
     28    FTP Site:    ftp.gnu.org
     29    Directory:   /pub/gnu
     30    File:        binutils-2.8.1.tar.gz
     31
     32newlib 1.8.0
     33    FTP Site:    ftp.cygnus.com
     34    Directory:   /pub/newlib
     35    File:        newlib-1.8.0.tar.gz
     36
     37RTEMS @value{version}
     38FTP Site:        ftp.oarcorp.com
     39    Directory:   /oarcorp/private/snapshots
     40    File:        rtems-980219.tgz
     41    File:        bit
     42    File:        binutils-2.8.1-rtems-diff-971221.gz
     43    File:        newlib-1.8.0-diff.980120.gz
     44    File:        simple_app.tgz
     45@end example
     46
     47
     48@section Create the tools directory
     49
     50Create a directory called tools that will serve as a working directory to
     51perform the build of the cross compiler tools.
     52
     53Unpack the compressed tar files using the following command sequence:
    1654
    1755@example
    1856cd tools
    19 tar xzf ../arc/rtems-980219.tgz
    20 @end example
    21 
    22 @section Add the bin directory under the install point to the default PATH
    23 
    24 Use the following command to append the <INSTALL_POINT>/bin directory to
    25 the PATH variable:
    26 
    27 @example
    28 PATH=$PATH:<INSTALL_POINT>/bin
    29 @end example
    30 
    31 @section Generate RTEMS for a specific target and board support package
    32 
    33 Make a build directory under tools and build the RTEMS product in this
    34 directory. The ../rtems-980219/configure command has numerous command line
    35 arguments. These arguments are discussed in detail in documentation that
    36 comes with the RTEMS distribution. In the installation described in the
    37 section "Unpack the RTEMS source", these configuration options can be found
    38 in file:
    39 
    40 @example
    41 tools/rtems-980219/README.configure
    42 @end example
    43 
    44 A simple example of the configuration appears below:
    45 
    46 @example
    47 mkdir build-rtems
    48 cd build-rtems
    49 ../rtems-980219/configure --target=<TARGET_CONFIGURATION> \
    50 --disable-posix --disable-ka9q --disable-cpp \
    51 --enable-rtemsbsp=<BOARD_SUPPORT_PACKAGE>\
    52 --prefix=< INSTALL_POINT>
    53 gmake all install
    54 @end example
     57tar xzf ../arc/egcs-1.0.2-980309-prerelease.tar.gz
     58tar xzf ../arc/binutls-2.8.1.tar.gz
     59tar xzf ../arc/newlib-1.8.0.tar.gz
     60@end example
     61
     62After the compressed tar files have been unpacked, the following
     63directories will have been created under tools.
     64
     65@itemize @bullet
     66@item binutils-2.8.1
     67@item egcs-1.0.2
     68@item newlib-1.8.0
     69@end itemize
     70
     71@section Apply patches for newlib
     72
     73Apply the patches using the following command sequence:
     74
     75@example
     76cd tools/newlib-1.8.0
     77zcat arc/newlib-1.8.0-diff.980120.gz|patch -p1
     78@end example
     79
     80Check to see if any of these patches have been rejected using the following
     81sequence:
     82
     83@example
     84cd tools/newlib-1.8.0
     85find . -name "*.rej" -print
     86@end example
     87
     88If any files are found with the .rej extension, a patch has been rejected.
     89This should not happen with a good patch file.
     90
     91To see the files that have been modified use the sequence:
     92
     93@example
     94cd tools/newlib-1.8.0
     95find . -name "*.orig" -print
     96@end example
     97
     98The files that are found, have been modified by the patch file.
     99
     100
     101@section Apply patches for binutils
     102
     103Apply the patches using the following command sequence:
     104
     105@example
     106cd tools/binutils-2.8.1
     107zcat arc/binutils-2.8.1-rtems-diff-971221.gz|patch -p1
     108@end example
     109
     110Check to see if any of these patches have been rejected using the following
     111sequence:
     112
     113@example
     114cd tools/binutils-2.8.1
     115find . -name "*.rej" -print
     116@end example
     117
     118If any files are found with the .rej extension, a patch has been rejected.
     119This should not happen with a good patch file.
     120
     121To see the files that have been modified use the sequence:
     122
     123@example
     124cd tools/binutils-2.8.1
     125find . -name "*.orig" -print
     126@end example
     127
     128The files that are found, have been modified by the patch file.
     129
     130@section Modify the bit script
     131
     132Copy the bit file from arc to the tools directory.
     133
     134Edit the bit file to alter the following environmental variables:
     135
     136@itemize @bullet
     137@item INSTALL_POINT
     138@item BINUTILS
     139@item NEWLIB
     140@item GCC
     141@item BUILD_DOCS
     142@end itemize
     143
     144These variables are located in the script section that resembles the
     145extract below:
     146
     147
     148@example
     149# USERCHANGE -- localize these.
     150#
     151#  INSTALL_POINT: Directory tools are installed into.
     152#      Recommended installation point for various OS's:
     153#         Linux:    /usr/local/rtems
     154#         Solaris:  /opt/gnu/rtems
     155#   BINUTILS:     Binutils source directory
     156#   NEWLIB:       Newlib source directory
     157#   GCC:          Newlib source directory
     158#   BUILD_DOCS:   Set to "yes" if you want to install documentation.
     159#
     160BINUTILS=gas-971208
     161GCC=egcs-1.0.1
     162NEWLIB=newlib-1.8.0
     163BUILD_DOCS=yes
     164INSTALL_POINT=/home/joel/$@{GCC@}/$@{target@}
     165
     166# USERCHANGE - uncomment this if you want to watch the commands.
     167@end example
     168
    55169
    56170Where:
    57171
    58 The current summary of <TARGET_CONFIGURATION>'s and
    59 <BOARD_SUPPORT_PACKAGE>'s can be found in
    60 tools/rtems-980219/README.configure
    61 
    62 
    63 <INSTALL_POINT> is the installation point from the previous step
    64 "Modify the bit script" in the build of the tools.
    65 
    66 
     172@table @code
     173@item INSTALL_POINT
     174is the location where you wish the GNU C/C++ cross compilation tools for
     175RTEMS to be built. It is recommended that the directory chosen to receive
     176these tools be named so that it is clear from which egcs distribution it
     177was generated and for which target system the tools are to produce code for.
     178
     179@item BINUTILS
     180is the directory under tools that contains binutils-2.8.1.
     181BINUTILS=binutils-2.8.1
     182
     183@item GCC
     184is the directory under tools that contains egcs-1.0.1.
     185GCC=egcs-1.0.2-980309-prerelease
     186
     187@item NEWLIB
     188is the directory under tools that contains newlib-1.8.0.
     189NEWLIB=newlib-1.8.0
     190
     191@item BUILD_DOCS
     192is set to "yes" if you want to install documentation.
     193BUILD_DOCS=yes
     194
     195@end table
     196
     197@section Running the bit script
     198
     199Run the modified bit script using the following sequence:
     200
     201@example
     202cd tools
     203./bit <target configuration>
     204@end example
     205
     206Where:
     207
     208<target configuration> is one of the following:
     209
     210@example
     211hppa1.1
     212i386
     213i386-elf
     214i386-go32
     215i960
     216m68k
     217mips64orion
     218powerpc
     219sh
     220sparc
     221@end example
     222
     223@section GNU C/C++ cross compiler toolset complete
     224 
     225At this point the GNU C/C++ cross compile tools should be built.
     226
  • doc/started/buildrt.t

    r417fcc73 r6113b3a  
     1@c
    12@c
    23@c  COPYRIGHT (c) 1988-1998.
     
    78@c
    89
    9 @chapter Building the GNU C/C++ Cross Compiler Toolset
     10@chapter Building RTEMS
    1011
    11 @section Get all the pieces
     12@section Unpack the RTEMS source
    1213
    13 The tree structure in the figure below is assumed to be present in the
    14 following discussions:
    15 
    16 Gather the components that will be required for the installation and place
    17 them in an archive directory. Call this directory arc. Be sure that there
    18 is sufficient space to hold all necessary information. This will amount to
    19 approximately 20 megabytes.
    20 
    21 Component       Location
    22 
    23 egcs 1.0.2      FTP Site:   egcs.cygnus.com
    24 Directory:   /pub/egcs/releases/egcs-1.0.2
    25 File:   egcs-1.0.2-980309-prerelease.tar.gz
    26 binutils 2.8.1  FTP Site:   ftp.gnu.org
    27 Directory: /pub/gnu
    28 File: binutils-2.8.1.tar.gz
    29 newlib 1.8.0    FTP Site:   ftp.cygnus.com
    30 Directory: /pub/newlib
    31 File: newlib-1.8.0.tar.gz
    32 rtems-980219.tgz        FTP Site:   ftp.oarcorp.com
    33 Directory: /oarcorp/private/snapshots
    34 File:    rtems-980219.tgz
    35 File:    bit
    36 File:    binutils-2.8.1-rtems-diff-971221.gz
    37 File:    newlib-1.8.0-diff.980120.gz
    38 File:    simple_app.tgz
    39 
    40 
    41 @section Create the tools directory
    42 
    43 Create a directory called tools that will serve as a working directory to
    44 perform the build of the cross compiler tools.
    45 
    46 Unpack the compressed tar files using the following command sequence:
     14Use the following command sequence to unpack the RTEMS source into the
     15tools directory:
    4716
    4817@example
    4918cd tools
    50 tar xzf ../arc/egcs-1.0.2-980309-prerelease.tar.gz
    51 tar xzf ../arc/binutls-2.8.1.tar.gz
    52 tar xzf ../arc/newlib-1.8.0.tar.gz
     19tar xzf ../arc/rtems-980219.tgz
    5320@end example
    5421
    55 After the compressed tar files have been unpacked, the following
    56 directories will have been created under tools.
     22@section Add the bin directory under the install point to the default PATH
    5723
    58 · binutils-2.8.1
    59 · egcs-1.0.2
    60 · newlib-1.8.0
    61 
    62 @section Apply patches for newlib
    63 
    64 Apply the patches using the following command sequence:
     24Use the following command to append the <INSTALL_POINT>/bin directory to
     25the PATH variable:
    6526
    6627@example
    67 cd tools/newlib-1.8.0
    68 zcat arc/newlib-1.8.0-diff.980120.gz|patch -p1
     28PATH=$PATH:<INSTALL_POINT>/bin
    6929@end example
    7030
    71 Check to see if any of these patches have been rejected using the following
    72 sequence:
     31@section Generate RTEMS for a specific target and board support package
     32
     33Make a build directory under tools and build the RTEMS product in this
     34directory. The ../rtems-980219/configure command has numerous command line
     35arguments. These arguments are discussed in detail in documentation that
     36comes with the RTEMS distribution. In the installation described in the
     37section "Unpack the RTEMS source", these configuration options can be found
     38in file:
    7339
    7440@example
    75 cd tools/newlib-1.8.0
    76 find . -name "*.rej" -print
     41tools/rtems-980219/README.configure
    7742@end example
    7843
    79 If any files are found with the .rej extension, a patch has been rejected.
    80 This should not happen with a good patch file.
    81 
    82 To see the files that have been modified use the sequence:
     44A simple example of the configuration appears below:
    8345
    8446@example
    85 cd tools/newlib-1.8.0
    86 find . -name "*.orig" -print
    87 @end example
    88 
    89 The files that are found, have been modified by the patch file.
    90 
    91 
    92 @section Apply patches for binutils
    93 
    94 Apply the patches using the following command sequence:
    95 
    96 @example
    97 cd tools/binutils-2.8.1
    98 zcat arc/binutils-2.8.1-rtems-diff-971221.gz|patch -p1
    99 @end example
    100 
    101 Check to see if any of these patches have been rejected using the following
    102 sequence:
    103 
    104 @example
    105 cd tools/binutils-2.8.1
    106 find . -name "*.rej" -print
    107 @end example
    108 
    109 If any files are found with the .rej extension, a patch has been rejected.
    110 This should not happen with a good patch file.
    111 
    112 To see the files that have been modified use the sequence:
    113 
    114 @example
    115 cd tools/binutils-2.8.1
    116 find . -name "*.orig" -print
    117 @end example
    118 
    119 The files that are found, have been modified by the patch file.
    120 
    121 @section Modify the bit script
    122 
    123 Copy the bit file from arc to the tools directory.
    124 
    125 Edit the bit file to alter the following environmental variables:
    126 
    127 · INSTALL_POINT
    128 · BINUTILS
    129 · NEWLIB
    130 · GCC
    131 · BUILD_DOCS
    132 
    133 These variables are located in the script section that resembles the
    134 extract below:
    135 
    136 
    137 @example
    138 # USERCHANGE -- localize these.
    139 #
    140 #  INSTALL_POINT: Directory tools are installed into.
    141 #      Recommended installation point for various OS's:
    142 #         Linux:    /usr/local/rtems
    143 #         Solaris:  /opt/gnu/rtems
    144 #   BINUTILS:     Binutils source directory
    145 #   NEWLIB:       Newlib source directory
    146 #   GCC:          Newlib source directory
    147 #   BUILD_DOCS:   Set to "yes" if you want to install documentation.
    148 #
    149 BINUTILS=gas-971208
    150 GCC=egcs-1.0.1
    151 NEWLIB=newlib-1.8.0
    152 BUILD_DOCS=yes
    153 INSTALL_POINT=/home/joel/${GCC}/${target}
    154 
    155 # USERCHANGE - uncomment this if you want to watch the commands.
    156 
    157 
    158 Where:
    159 
    160 INSTALL_POINT is the location where you wish the GNU C/C++ cross compilation tools for RTEMS to be built. It is recommended that the directory chosen to receive these tools be named so that it is clear from which egcs distribution it was generated and for which target system the tools are to produce code for.
    161 
    162 BINUTILS is the directory under tools that contains binutils-2.8.1.
    163 BINUTILS=binutils-2.8.1
    164 
    165 GCC is the directory under tools that contains egcs-1.0.1.
    166 GCC=egcs-1.0.2-980309-prerelease
    167 
    168 NEWLIB is the directory under tools that contains newlib-1.8.0.
    169 NEWLIB=newlib-1.8.0
    170 
    171 BUILD_DOCS   is set to "yes" if you want to install documentation.
    172 BUILD_DOCS=yes
    173 
    174 @section Running the bit script
    175 
    176 Run the modified bit script using the following sequence:
    177 
    178 @example
    179 cd tools
    180 ./bit <target configuration>
     47mkdir build-rtems
     48cd build-rtems
     49../rtems-980219/configure --target=<TARGET_CONFIGURATION> \
     50--disable-posix --disable-ka9q --disable-cpp \
     51--enable-rtemsbsp=<BOARD_SUPPORT_PACKAGE>\
     52--prefix=< INSTALL_POINT>
     53gmake all install
    18154@end example
    18255
    18356Where:
    18457
    185 <target configuration> is one of the following:
     58The current summary of <TARGET_CONFIGURATION>'s and
     59<BOARD_SUPPORT_PACKAGE>'s can be found in
     60tools/rtems-980219/README.configure
    18661
    187 @example
    188 hppa1.1
    189 i386
    190 i386-go32
    191 i960
    192 m68k
    193 mips64orion
    194 powerpc
    195 sh
    196 sparc
    197 @end example
    19862
    199 @section GNU C/C++ cross compiler toolset complete
    200  
    201 At this point the GNU C/C++ cross compile tools should be built.
     63<INSTALL_POINT> is the installation point from the previous step
     64"Modify the bit script" in the build of the tools.
    20265
     66
  • doc/started/gdb.t

    r417fcc73 r6113b3a  
    77@c
    88
    9 @chapter Building the GDB Debugger
     9@chapter Building the GNU Debugger
    1010
    1111GDB is not currently RTEMS aware. The following configurations have been
     
    1414@section GDB with Sparc Instruction Simulation (SIS)
    1515
    16 @subsection Unarchive the gdb distribution
     16@subsection Unarchive the gdb distribution (SIS)
    1717
    1818Use the following commands to unarchive the gdb distribution:
     
    2525The directory gdb-980122 is created under the tools directory.
    2626
    27 @subsection Make the build directory
     27@subsection Make the build directory (SIS)
    2828
    2929Create a build directory for the SIS Debugger
     
    3434@end example
    3535
    36 @subsection Configure for the build
     36@subsection Configure for the build (SIS)
    3737
    3838Configure the general gdb distribution for Sparc Instruction Simulation
     
    5252created.
    5353
    54 @subsection Make the debugger
     54@subsection Make the debugger (SIS)
    5555
    5656From tools/build-sis run:
     
    6161
    6262
    63 @section GDB with PowerPC instruction Simulation(PSIM)
     63@section GDB with PowerPC Instruction Simulator (PSIM)
    6464
    65 @subsection Unarchive the gdb distribution
     65@subsection Unarchive the gdb distribution (PSIM)
    6666
    6767Use the following commands to unarchive the gdb distribution:
     
    7575
    7676
    77 @subsection Make the build directory
     77@subsection Make the build directory (PSIM)
    7878
    7979Create a build directory for the SIS Debugger
     
    106106
    107107
    108 @subsection Make the debugger
     108@subsection Make the debugger (PSIM)
    109109
    110110From tools/build-ppc run:
     
    117117@section GDB with Dink32
    118118
    119 @subsection Unarchive the gdb distribution
     119@subsection Unarchive the gdb distribution (DINK32)
    120120
    121121Use the following commands to unarchive the gdb distribution:
     
    129129
    130130
    131 @subsection Make the build directory
     131@subsection Make the build directory (DINK32)
    132132
    133 Create a build directory for the SIS Debugger
     133Create a build directory for the DINK32 Debugger
    134134
    135135@example
     
    150150
    151151
    152 @subsection Configure for the build
     152@subsection Configure for the build (DINK32)
    153153
    154154Configure the general gdb distribution for Sparc Instruction Simulation
     
    167167be created.
    168168
    169 @subsection Make the debugger
     169@subsection Make the debugger (DINK32)
    170170
    171171From tools/build-dink32 run:
  • doc/started/intro.t

    r417fcc73 r6113b3a  
    1313essentials for performing a setup of the following items:
    1414
    15 · GNU C/C++ Cross Compilation Tools for RTEMS on your host system
    16 · RTEMS OS for the target host
    17 · GDB Debugger
     15@itemize @bullet
     16@item GNU C/C++ Cross Compilation Tools for RTEMS on your host system
     17@item RTEMS OS for the target host
     18@item GDB Debugger
     19@end itemize
    1820
    1921
  • doc/started/started.texi

    r417fcc73 r6113b3a  
    6363@c  The alternative is to rework a sentence to avoid this problem.
    6464
    65 @include intro.t
    66 @include require.t
    67 @include buildc.t
    68 @include buildrt.t
    69 @include sample.t
    70 @include gdb.t
     65@include intro.texi
     66@include require.texi
     67@include buildc.texi
     68@include buildrt.texi
     69@include sample.texi
     70@include gdb.texi
    7171
    7272@ifinfo
    73 @node Top, Preface, (dir), (dir)
     73@node Top, Introduction, (dir), (dir)
    7474@top started
    7575
     
    9494@c
    9595
    96 @node Command and Variable Index, Concept Index, Overall Summary, Top
     96@node Command and Variable Index, Concept Index, Make the debugger (DINK32), Top
    9797@unnumbered Command and Variable Index
    9898
Note: See TracChangeset for help on using the changeset viewer.