Changeset 77ea5d30 in rtems


Ignore:
Timestamp:
Oct 20, 1998, 12:30:06 PM (21 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
e8e2cf13
Parents:
0b5dbf1f
Message:

Added information about the new build scripts. The biggest thing was
describing the user.cfg file.

Added a section on Solaris 2.x.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/started/buildc.t

    r0b5dbf1f r77ea5d30  
    105105    FTP Site:    @value{RTEMS-FTPSITE}
    106106    Directory:   @value{RTEMS-FTPDIR}/c_tools
    107     File:        bit
     107    File:        @value{BUILDTOOLS-TAR}
    108108@ifset BINUTILS-RTEMSPATCH
    109109    File:        @value{BINUTILS-RTEMSPATCH}
     
    130130tar xzf ../archive/@value{BINUTILS-TAR}
    131131tar xzf ../archive/@value{NEWLIB-TAR}
     132tar xzf ../archive/@value{BUILDTOOLS-TAR}
    132133@end example
    133134
     
    141142@end itemize
    142143
    143 Copy the @code{bit} script from the @code{archive} directory
    144 to the @code{tools} directory as shown below:
    145 
    146 @example
    147 cp ../archive/bit .
    148 @end example
     144There will also be a set of scripts in the current directory
     145which aid in building the tools and RTEMS.  They are:
     146
     147@itemize @bullet
     148@item bit
     149@item bit_gdb
     150@item bit_rtems
     151@item common.sh
     152@item user.cfg
     153@end itemize
    149154
    150155When the @code{bit} script is executed later in this process,
     
    156161@end itemize
    157162
    158 @itemize @bullet
    159 @item src
    160 @item build-$@{CPU@}-tools
    161 @end itemize
     163Similarly, the @code{bit_gdb} script will create the
     164subdirectory @code{build-$@{CPU@}-gdb} and
     165the @code{bit_rtems} script will create the
     166subdirectory @code{build-$@{CPU@}-rtems}.
    162167
    163168The tree should look something like the following figure:
     
    166171@group
    167172/whatever/prefix/you/choose/
    168         bit
    169173        archive/
    170174            @value{GCC-TAR}
     
    172176            @value{NEWLIB-TAR}
    173177            @value{RTEMS-TAR}
     178            @value{BUILDTOOLS-TAR}
    174179@ifset GCC-RTEMSPATCH
    175180            @value{GCC-RTEMSPATCH}
     
    189194            @value{RTEMS-UNTAR}/
    190195            bit
    191 
     196            bit_gdb
     197            bit_rtems
     198            common.sh
     199            user.cfg
    192200@end group
    193201@end example
     
    201209
    202210@c
     211@c  Host Specific Notes
     212@c
     213
     214@section Host Specific Notes
     215
     216@subsection Solaris 2.x
     217
     218The build scripts are written in "shell".  The program @code{/bin/sh}
     219on Solaris 2.x is not robust enough to execute these scripts.  If you
     220are on a Solaris 2.x host, then change the first line of the files
     221@code{bit}, @code{bit_gdb}, and @code{bit_rtems} to use the
     222@code{/bin/ksh} shell instead.
     223
     224@c
    203225@c  Reading the Documentation
    204226@c
     
    239261
    240262If any files are found with the .rej extension, a patch has been rejected.
    241 This should not happen with a good patch file.
     263This should not happen with a good patch file which is properly applied.
    242264
    243265@end ifset
     
    271293
    272294If any files are found with the .rej extension, a patch has been rejected.
    273 This should not happen with a good patch file.
     295This should not happen with a good patch file which is properly applied.
    274296
    275297@end ifset
     
    304326
    305327If any files are found with the .rej extension, a patch has been rejected.
    306 This should not happen with a good patch file.
    307 
    308 @end ifset
    309 
    310 @c
    311 @c  Modify the bit script
    312 @c
    313 
    314 @section Modify the bit Script
    315 
    316 Copy the @code{bit} script from @code{archive} to the tools directory.
    317 
    318 Edit the @code{bit} file to alter the following environmental variables:
    319 
    320 @itemize @bullet
    321 @item INSTALL_POINT
    322 @item BINUTILS
    323 @item NEWLIB
    324 @item GCC
    325 @item BUILD_DOCS
    326 @item BUILD_OTHER_LANGUAGES
    327 @end itemize
    328 
    329 These variables are located in the script section that resembles the
    330 extract below:
    331 
    332 
    333 @example
    334 # USERCHANGE -- localize these.
    335 #
    336 #  INSTALL_POINT: Directory tools are installed into.
    337 #      Recommended installation point for various OS's:
    338 #         Linux:    /usr/local/rtems
    339 #         Solaris:  /opt/gnu/rtems
    340 #   BINUTILS:     Binutils source directory
    341 #   NEWLIB:       Newlib source directory
    342 #   GCC:          Newlib source directory
    343 #   BUILD_DOCS:   Set to "yes" if you want to install documentation.
    344 #   BUILD_OTHER_LANGUAGES:
    345 #                 Set to "yes" if you want to build Fortran and Objective-C
    346 #
    347 BINUTILS=@value{BINUTILS-UNTAR}
    348 GCC=@value{GCC-UNTAR}
    349 NEWLIB=@value{NEWLIB-UNTAR}
    350 BUILD_DOCS=yes
    351 BUILD_OTHER_LANGUAGES=yes
    352 INSTALL_POINT=/home/joel/$@{GCC@}/$@{target@}
    353 
    354 # USERCHANGE - uncomment this if you want to watch the commands.
    355 @end example
    356 
    357 Where each of the variables which may be modified is described below:
     328This should not happen with a good patch file which is properly applied.
     329
     330@end ifset
     331
     332@c
     333@c  Localizing the Configuration
     334@c
     335
     336@section Localizing the Configuration
     337
     338Edit the @code{user.cfg} file to alter the settings of various
     339variables which are used to tailor the build process.
     340Each of the variables set in @code{user.cfg} may be modified
     341as described below:
    358342
    359343@table @code
     
    409393@end example
    410394
     395@b{NOTE:} Based upon the version of the compiler being used, it may not
     396be possible to build languages other than C and C++ cross.  In many cases,
     397the language run-time support libraries are not "multilib'ed".  Thus the
     398executable code in these libraries will be for the default compiler settings
     399and not necessarily be correct for your CPU model.
     400
     401@item RTEMS
     402is the directory under tools that contails @value{RTEMS-UNTAR}.
     403
     404@item ENABLE_RTEMS_POSIX
     405is set to "yes" if you want to enable the RTEMS POSIX API support.
     406At this time, this feature is not supported by the UNIX ports of RTEMS
     407and is forced to "no" for those targets.  This corresponds to the
     408@code{configure} option @code{--enable-posix}.
     409
     410@item ENABLE_RTEMS_TESTS
     411is set to "yes" if you want to build the RTEMS Test Suite.  If this
     412is set to "no", then only the Sample Tests will be built.
     413This corresponds to the @code{configure} option @code{--enable-tests}.
     414
     415@item ENABLE_RTEMS_TCPIP
     416is set to "yes" if you want to build the RTEMS TCP/IP Stack.  If a
     417particular BSP does not support TCP/IP, then this feature is automatically
     418disabled.  This corresponds to the @code{configure} option
     419@code{--enable-tcpip}.
     420
     421@item ENABLE_RTEMS_CXX
     422is set to "yes" if you want to build the RTEMS C++ support including
     423the C++ Wrapper for the Classic API.  This corresponds to the
     424@code{configure} option @code{--enable-cxx}.
    411425@end table
    412426
Note: See TracChangeset for help on using the changeset viewer.