Changeset 4a675a5c in rtems


Ignore:
Timestamp:
Nov 13, 2002, 8:20:29 PM (17 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
66bdac37
Parents:
5a951c9
Message:

2002-11-13 Joel Sherrill <joel@…>

  • Makefile.am, buildc.t, buildrt.t, nt.t, require.t, tversions.texi: Removed all references to bit scripts.
  • gdb.t: Removed.
Location:
doc/started
Files:
1 deleted
7 edited

Legend:

Unmodified
Added
Removed
  • doc/started/ChangeLog

    r5a951c9 r4a675a5c  
     12002-11-13      Joel Sherrill <joel@OARcorp.com>
     2
     3        * Makefile.am, buildc.t, buildrt.t, nt.t, require.t, tversions.texi:
     4        Removed all references to bit scripts.
     5        * gdb.t: Removed.
     6
    172002-11-13      Joel Sherrill <joel@OARcorp.com>
    28
  • doc/started/Makefile.am

    r5a951c9 r4a675a5c  
    5353
    5454$(srcdir)/sample.texi: sample.t tversions.texi
    55         $(BMENU2) -c -p "Using the bit_rtems Script" \
     55        $(BMENU2) -c -p "Using the RTEMS configure Script Directly" \
    5656            -u "Top" \
    5757            -n "Where To Go From Here" < $< > $@
     
    6767            -n "" < $< > $@
    6868
    69 EXTRA_DIST = binaries.t buildc.t buildrt.t gdb.t intro.t nextstep.t nt.t \
     69EXTRA_DIST = binaries.t buildc.t buildrt.t intro.t nextstep.t nt.t \
    7070    require.t sample.t
  • doc/started/buildc.t

    r5a951c9 r4a675a5c  
    116116
    117117NOTE: This step is required if building BINUTILS, GCC, and NEWLIB
    118 using the procedures described in @ref{Using configure and make}
    119 or @ref{Using the bit Script}.  It is @b{NOT} required if using the procedure
     118using the procedure described in @ref{Using configure and make}.
     119It is @b{NOT} required if using the procedure
    120120described in @ref{Using RPM to Build BINUTILS GCC and NEWLIB}.
    121121
     
    170170@end example
    171171
    172 @c @ifset use-html
    173 @c @html
    174 @c <IMG SRC="bit_c.jpg" WIDTH=816 HEIGHT=267 ALT="Directory Organization">
    175 @c @end html
    176 @c @end ifset
    177 
    178172@c
    179173@c  Applying RTEMS Patches
     
    183177
    184178NOTE: This step is required if building BINUTILS, GCC, and NEWLIB
    185 using the procedures described in @ref{Using configure and make}
    186 or @ref{Using the bit Script}.  It is @b{NOT} required if using the procedure
     179using the procedures described in @ref{Using configure and make}.
     180It is @b{NOT} required if using the procedure
    187181described in @ref{Using RPM to Build BINUTILS GCC and NEWLIB}.
    188182
     
    298292@subsection Compiling and Installing BINUTILS GCC and NEWLIB
    299293
    300 There are three methods to compile and install BINUTILS, GCC, and NEWLIB:
     294There are two supported methods to compile and install BINUTILS, GCC,
     295and NEWLIB:
    301296
    302297@itemize @bullet
    303298@item RPM
    304299@item direct invocation of @code{configure} and @code{make}
    305 @item using the @code{bit} script
    306300@end itemize
    307301
     
    545539
    546540@c
    547 @c  Using the bit Script
    548 @c
    549 
    550 @subsubsection Using the bit Script
    551 
    552 NOTE:  The procedures described in the following sections must
    553 be completed before this step:
    554 
    555 @itemize @bullet
    556 @item @ref{Obtain Source and Patches for BINUTILS GCC and NEWLIB}
    557 @item @ref{Unarchiving the Tools}
    558 @item @ref{Applying RTEMS Patches}
    559 @end itemize
    560 
    561 This section describes the process of building using the
    562 @code{bit} script.  This script hides many of the details
    563 of building the tools but can be a hindrance if you
    564 encounter problems building the tools.
    565 
    566 @c
    567 @c  Unarchiving the Build Scripts
    568 @c
    569 
    570 @subheading Unarchiving the Build Scripts
    571 
    572 While in the @code{tools} directory, unpack the compressed
    573 tar file for the build tools using the following command sequence:
    574 
    575 @example
    576 cd tools
    577 tar xzf ../archive/@value{BUILDTOOLS-TAR}
    578 @end example
    579 
    580 After the compressed tar file @value{BUILDTOOLS-TAR} has been unpacked, there
    581 will be a set of scripts in the tools directory along with
    582 any source code you have previously unarchived.
    583 These scripts are intended to aid in building the tools and RTEMS.
    584 These scripts may be used to automate the tool building process and hide
    585 the invocation of @code{configure} and @code{make} from you.  They are:
    586 
    587 @itemize @bullet
    588 @item bit
    589 @item bit_gdb
    590 @item bit_rtems
    591 @item common.sh
    592 @item user.cfg
    593 @end itemize
    594 
    595 If @code{bit} is executed later in this process,
    596 it will automatically create this subdirectory:
    597 
    598 @itemize @bullet
    599 @item build-$@{CPU@}-tools
    600 @end itemize
    601 
    602 At this point, the tree should look something like the following figure:
    603 
    604 @example
    605 @group
    606 /whatever/prefix/you/choose/
    607         archive/
    608             @value{GCC-TAR}
    609             @value{BINUTILS-TAR}
    610             @value{NEWLIB-TAR}
    611             @value{BUILDTOOLS-TAR}
    612 @ifset GCC-RTEMSPATCH
    613             @value{GCC-RTEMSPATCH}
    614 @end ifset
    615 @ifset BINUTILS-RTEMSPATCH
    616             @value{BINUTILS-RTEMSPATCH}
    617 @end ifset
    618 @ifset NEWLIB-RTEMSPATCH
    619             @value{NEWLIB-RTEMSPATCH}
    620 @end ifset
    621         tools/
    622             @value{BINUTILS-UNTAR}/
    623             @value{GCC-UNTAR}/
    624             @value{NEWLIB-UNTAR}/
    625             bit
    626             bit_gdb
    627             bit_rtems
    628             common.sh
    629             user.cfg
    630 @end group
    631 @end example
    632 
    633 @c @ifset use-html
    634 @c @html
    635 @c <IMG SRC="bit_c.jpg" WIDTH=816 HEIGHT=267 ALT="Directory Organization">
    636 @c @end html
    637 @c @end ifset
    638 
    639 @c
    640 @c  Localizing the Configuration
    641 @c
    642 
    643 @subheading Localizing the Configuration
    644 
    645 Edit the @code{user.cfg} file to alter the settings of various
    646 variables which are used to tailor the build process.
    647 Each of the variables set in @code{user.cfg} may be modified
    648 as described below:
    649 
    650 @table @code
    651 @item INSTALL_POINT
    652 is the location where you wish the GNU C/C++ cross compilation tools for
    653 RTEMS to be built. It is recommended that the directory chosen to receive
    654 these tools be named so that it is clear from which gcc distribution it
    655 was generated and for which target system the tools are to produce code for.
    656 
    657 @b{WARNING}: The @code{INSTALL_POINT} should not be a subdirectory
    658 under the build directory.  The build directory will be removed
    659 automatically upon successful completion of the build procedure.
    660 
    661 @item BINUTILS
    662 is the directory under tools that contains @value{BINUTILS-UNTAR}.
    663 For example:
    664 
    665 @example
    666 BINUTILS=@value{BINUTILS-UNTAR}
    667 @end example
    668 
    669 @item GCC
    670 is the directory under tools that contains @value{GCC-UNTAR}.
    671 For example,
    672 
    673 @example
    674 GCC=@value{GCC-UNTAR}
    675 @end example
    676 
    677 @item GDB
    678 is the directory under tools that contains @value{GDB-UNTAR}.
    679 For example,
    680 
    681 @example
    682 GDB=@value{GDB-UNTAR}
    683 @end example
    684 
    685 @item NEWLIB
    686 is the directory under tools that contains @value{NEWLIB-UNTAR}.
    687 For example:
    688 
    689 @example
    690 NEWLIB=@value{NEWLIB-UNTAR}
    691 @end example
    692 
    693 @item BUILD_DOCS
    694 is set to "yes" if you want to install documentation.  This requires
    695 that tools supporting documentation production be installed.  This
    696 currently is limited to the GNU texinfo package.
    697 For example:
    698 
    699 @example
    700 BUILD_DOCS=yes
    701 @end example
    702 
    703 @item BUILD_OTHER_LANGUAGES
    704 is set to "yes" if you want to build languages other than C and C++.  At
    705 the current time, the set of alternative languages includes Java, Fortran,
    706 and Objective-C.  These alternative languages do not always build cross.
    707 Hence this option defaults to "no".
    708 
    709 For example:
    710 
    711 @example
    712 BUILD_OTHER_LANGUAGES=yes
    713 @end example
    714 
    715 @b{NOTE:} Based upon the version of the compiler being used, it may not
    716 be possible to build languages other than C and C++ cross.  In many cases,
    717 the language run-time support libraries are not "multilib'ed".  Thus the
    718 executable code in these libraries will be for the default compiler settings
    719 and not necessarily be correct for your CPU model.
    720 
    721 @end table
    722 
    723 The other variables in @code{user.cfg} are RTEMS specific and are
    724 not technically required to be set unless you build RTEMS using
    725 the @code{bit_rtems} script as described in
    726 @ref{Using the bit_rtems Script}.  They are described in detail
    727 in that section.
    728 
    729 @c
    730 @c   Running the bit Script
    731 @c
    732 @subheading Running the bit Script
    733 
    734 After the @code{bit} script has been modified to reflect the
    735 local installation, the modified @code{bit} script is run
    736 using the following sequence:
    737 
    738 @example
    739 cd tools
    740 ./bit <target configuration>
    741 @end example
    742 
    743 Where <target configuration> is one of the following:
    744 
    745 @itemize @bullet
    746 @item hppa1.1
    747 @item i386
    748 @item i386-coff
    749 @item i386-elf
    750 @item i960
    751 @item m68k
    752 @item m68k-coff
    753 @item mips64orion
    754 @item powerpc
    755 @item sh
    756 @item sh-elf
    757 @item sparc
    758 @end itemize
    759 
    760 The build process can take a while to complete.  Many users find it
    761 handy to run the build process in the background, capture the output
    762 in a file, and monitor the output.  This can be done as follows:
    763 
    764 @example
    765 ./bit <target configuration> >bit.log 2>&1 &
    766 tail -f bit.log
    767 @end example
    768 
    769 If no errors are encountered, the @code{bit} script will conclude by
    770 printing messages similar to the following:
    771 
    772 @example
    773 
    774 The build-i386-tools subdirectory may now be removed.
    775 
    776 Started:  Fri Apr 10 10:14:07 CDT 1998
    777 Finished: Fri Apr 10 12:01:33 CDT 1998
    778 @end example
    779 
    780 If the @code{bit} script successfully completes, then the
    781 GNU C/C++ cross compilation tools are installed.
    782 
    783 If the @code{bit} script does not successfully complete, then investigation
    784 will be required to determine the source of the error.
    785 
    786 @c -------------------
    787 
    788 @c
    789541@c Building the GNU Debugger GDB
    790542@c
     
    920672@item RPM
    921673@item direct invocation of @code{configure} and @code{make}
    922 @item using the @code{bit_gdb} script
    923674@end itemize
    924675
     
    1045796@code{--help} option.
    1046797
    1047 @subsubsection Using the bit_gdb Script
    1048 
    1049 The simplest way to build gdb for RTEMS is to use the @code{bit_gdb} script.
    1050 This script interprets the settings in the @code{user.cfg} file to
    1051 produce the GDB configuration most appropriate for the target CPU.
    1052 The variables in @code{user.cfg} were described in @ref{Using the bit Script}
    1053 but only the @code{GDB} variable setting is used by @code{bit_gdb}.
    1054 
    1055 The @code{bit_gdb} script is invoked as follows:
    1056 
    1057 @example
    1058 ./bit_gdb CPU
    1059 @end example
    1060 
    1061 Where CPU is one of the RTEMS supported CPU families from the following
    1062 list:
    1063 
    1064 @itemize @bullet
    1065 @item hppa1.1
    1066 @item i386
    1067 @item i386-coff
    1068 @item i386-elf
    1069 @item i960
    1070 @item m68k
    1071 @item m68k-coff
    1072 @item mips64orion
    1073 @item powerpc
    1074 @item sh
    1075 @item sh-elf
    1076 @item sparc
    1077 @end itemize
    1078 
    1079 If gdb supports a CPU instruction simulator for this configuration, then
    1080 it is included in the build.
    1081 
    1082 @c -------------------
    1083 
    1084798@c
    1085799@c Common Problems
  • doc/started/buildrt.t

    r5a951c9 r4a675a5c  
    120120This section describes how to configure and build RTEMS
    121121so that it is specifically tailored for your BSP and the
    122 CPU model it uses.  There are two methods to compile and install RTEMS:
     122CPU model it uses.  There is currently only one supported
     123method to compile and install RTEMS:
    123124
    124125@itemize @bullet
    125126@item direct invocation of @code{configure} and @code{make}
    126 @item using the @code{bit} script
    127127@end itemize
    128128
    129129Direct invocation of @code{configure} and @code{make} provides more control
    130 and easier recovery from problems when building.
     130and easier recovery from problems when building. 
    131131
    132132This section describes how to build RTEMS.
     
    169169tools and is @code{/opt/rtems} when using prebuilt toolset executables.
    170170
    171 NOTE: The @code{make} utility used should be GNU make.
    172 
    173 @c
    174 @c Using the bit_rtems Script
    175 @c
    176 
    177 @subsection Using the bit_rtems Script
    178 
    179 If you have not previously unarchived the build tools, then you
    180 will need to unarchive the build scripts at this point if you
    181 plan to use @code{bit_rtems} to build RTEMS.  If this is the
    182 case, you will have to execute the following additional command
    183 since you did not do it as part of building the tools.
    184 
    185 @example
    186 cd tools
    187 tar xzf ../archive/@value{BUILDTOOLS-TAR}
    188 @end example
    189 
    190 This script interprets the settings in the @code{user.cfg} file to
    191 enable or disable the various RTEMS options.  The RTEMS
    192 specific entries described below must be set to
    193 tailor the RTEMS configuration to meet your application requirements:
    194 
    195 @table @code
    196 
    197 @item RTEMS
    198 is the directory under tools that contains @value{RTEMS-UNTAR}.
    199 
    200 @item ENABLE_RTEMS_POSIX
    201 is set to "yes" if you want to enable the RTEMS POSIX API support.
    202 At this time, this feature is not supported by the UNIX ports of RTEMS
    203 and is forced to "no" for those targets.  This corresponds to the
    204 @code{configure} option @code{--enable-posix}.
    205 
    206 @item ENABLE_RTEMS_ITRON
    207 is set to "yes" if you want to enable the RTEMS ITRON API support.
    208 At this time, this feature is not supported by the UNIX ports of RTEMS
    209 and is forced to "no" for those targets.  This corresponds to the
    210 @code{configure} option @code{--enable-itron}.
    211 
    212 @item ENABLE_RTEMS_MP
    213 is set to "yes" if you want to enable the RTEMS multiprocessing
    214 support.  This feature is not supported by all RTEMS BSPs and
    215 is automatically forced to "no" for those BSPs.  This corresponds to the
    216 @code{configure} option @code{--enable-multiprocessing}.
    217 
    218 @item ENABLE_RTEMS_CXX
    219 is set to "yes" if you want to build the RTEMS C++ support including
    220 the C++ Wrapper for the Classic API.  This corresponds to the
    221 @code{configure} option @code{--enable-cxx}.
    222 
    223 @item ENABLE_RTEMS_TESTS
    224 is set to "yes" if you want to build the RTEMS Test Suite.  If this
    225 is set to "no", then only the Sample Tests will be built.  Setting
    226 this option to "yes" significantly increases the amount of disk
    227 space required to build RTEMS.
    228 This corresponds to the @code{configure} option @code{--enable-tests}.
    229 
    230 @item ENABLE_RTEMS_TCPIP
    231 is set to "yes" if you want to build the RTEMS TCP/IP Stack.  If a
    232 particular BSP does not support TCP/IP, then this feature is automatically
    233 disabled.  This corresponds to the @code{configure} option
    234 @code{--enable-tcpip}.
    235 
    236 @item ENABLE_RTEMS_NONDEBUG
    237 is set to "yes" if you want to build RTEMS in a fully optimized
    238 state.  This corresponds to executing @code{make} after configuring
    239 the source tree.
    240 
    241 @item ENABLE_RTEMS_DEBUG
    242 is set to "yes" if you want to build RTEMS in a debug version.
    243 When built for debug, RTEMS will include run-time code to
    244 perform consistency checks such as heap consistency checks.
    245 Although the precise compilation arguments are BSP dependent,
    246 the debug version of RTEMS is usually built at a lower optimization
    247 level.  This is usually done to reduce inlining which can make
    248 tracing code execution difficult.  This corresponds to executing
    249 @code{make VARIANT=debug} after configuring
    250 the source tree.
    251 
    252 @item INSTALL_RTEMS
    253 is set to "yes" if you want to install RTEMS after building it.
    254 This corresponds to executing @code{make install} after configuring
    255 and building the source tree.
    256 
    257 @item ENABLE_RTEMS_MAINTAINER_MODE
    258 is set to "yes" if you want to enabled maintainer mode functionality
    259 in the RTEMS Makefile.  This is disabled by default and it is not
    260 expected that most users will want to enable this.  When this option
    261 is enabled, the build process may attempt to regenerate files that
    262 require tools not required when this option is disabled.
    263 This corresponds to the @code{configure} option
    264 @code{--enable-maintainer-mode}.
    265 
    266 @end table
    267 
    268 After tailoring @code{user.cfg} for your application, the @code{bit_rtems}
    269 script may be invoked as follows:
    270 
    271 @example
    272 ./bit_rtems CPU [BSP]
    273 @end example
    274 
    275 Where CPU is one of the RTEMS supported CPU families from the following
    276 list:
    277 
    278 @itemize @bullet
    279 @item hppa1.1
    280 @item i386
    281 @item i386-coff
    282 @item i386-elf
    283 @item i960
    284 @item m68k
    285 @item m68k-coff
    286 @item mips64orion
    287 @item powerpc
    288 @item sh
    289 @item sh-elf
    290 @item sparc
    291 @end itemize
    292 
    293171BSP is a supported BSP for the selected CPU family.  The list of
    294172supported BSPs may be found in the file
     
    299177@b{NOTE:}  The POSIX API must be enabled to use GNAT/RTEMS.
    300178
     179@b{NOTE:} The @code{make} utility used should be GNU make.
     180
  • doc/started/nt.t

    r5a951c9 r4a675a5c  
    4444
    4545@item If you want to build the tools from source, you have the
    46 same options as UNIX users -- @code{bit} or @code{RPM}.
     46same options as UNIX users.
    4747
    4848@end itemize
     
    280280
    281281Replace @code{m68k-rtems} with the target configuration
    282 of your choice.  See @ref{Using the bit Script} for a
     282of your choice.  See @ref{Using the RTEMS configure Script Directly} for a
    283283list of the targets available.
    284284
     
    358358
    359359Replace @code{m68k-rtems} with the target configuration
    360 of your choice.  See @ref{Using the bit Script} for a
     360of your choice.  See @ref{Using the RTEMS configure Script Directly} for a
    361361list of the targets available.
    362362
  • doc/started/require.t

    r5a951c9 r4a675a5c  
    121121@item The build scripts are written in "shell".  The program @code{/bin/sh}
    122122on Solaris 2.x is not robust enough to execute these scripts.  If you
    123 are on a Solaris 2.x host, then change the first line of the files
    124 @code{bit}, @code{bit_gdb}, and @code{bit_rtems} to use the
    125 @code{/bin/ksh} shell instead.
     123are on a Solaris 2.x host, then use the @code{/bin/ksh} or
     124@code{/bin/bash} shell instead.
    126125
    127126@item The native @code{patch} program is broken.  Install the GNU version.
  • doc/started/tversions.texi

    r5a951c9 r4a675a5c  
    2222@c
    2323
    24 @set GCC-VERSION     gcc 3.1
    25 @set GCC-TAR         gcc-3.1.tar.gz
    26 @set GCC-UNTAR       gcc-3.1
     24@set GCC-VERSION     gcc 3.2
     25@set GCC-TAR         gcc-3.2.tar.gz
     26@set GCC-UNTAR       gcc-3.2
    2727@set GCC-FTPSITE     gcc.gnu.org
    2828@set GCC-FTPDIR      /pub/gnu/gcc/
    2929@set GCC-HTTPDIR     /pub/gcc/releases/index.html
    30 @set GCC-RTEMSPATCH  gcc-3.1-rtems-200205XX.diff.gz
     30@set GCC-RTEMSPATCH  gcc-3.2-rtems-20021107.diff
    3131
    3232@c
     
    3535
    3636@c The "official" binutils
    37 @set BINUTILS-VERSION     binutils 2.12
    38 @set BINUTILS-TAR         binutils-2.12.tar.gz
    39 @set BINUTILS-UNTAR       binutils-2.12
     37@set BINUTILS-VERSION     binutils 2.13.1
     38@set BINUTILS-TAR         binutils-2.13.1.tar.gz
     39@set BINUTILS-UNTAR       binutils-2.13.1
    4040@set BINUTILS-FTPSITE     ftp.gnu.org
    4141@set BINUTILS-FTPDIR      /pub/gnu/binutils
     
    6868@set NEWLIB-FTPSITE     sources.redhat.com
    6969@set NEWLIB-FTPDIR      /pub/newlib
    70 @set NEWLIB-RTEMSPATCH  newlib-1.10.0-rtems-200205XX.diff.gz
     70@set NEWLIB-RTEMSPATCH  newlib-1.10.0-rtems-20021101.diff.gz
    7171
    7272@c
     
    8585@c
    8686
    87 @set RTEMS-VERSION   RTEMS SS-200206XX
    88 @set RTEMS-TAR       rtems-ss-200206xx.tgz
    89 @set RTEMS-UNTAR     rtems-ss-200206xx
     87@set RTEMS-VERSION   RTEMS SS-20021111
     88@set RTEMS-TAR       rtems-ss-20021111.tar.bz2
     89@set RTEMS-UNTAR     rtems-ss-20021111
    9090@set RTEMS-FTPSITE   ftp.OARcorp.com
    91 @set RTEMS-FTPDIR    /pub/rtems/releases/4.5.1
    92 @set BUILDTOOLS-TAR  c_build_scripts-4.5.1.tgz
     91@set RTEMS-FTPDIR    /pub/rtems/cd-working
     92@c @set BUILDTOOLS-TAR  c_build_scripts-4.5.1.tgz
    9393
    9494
Note: See TracChangeset for help on using the changeset viewer.