Changeset 4a675a5c in rtems
- Timestamp:
- 11/13/02 20:20:29 (21 years ago)
- Branches:
- 4.10, 4.11, 4.8, 4.9, 5, master
- Children:
- 66bdac37
- Parents:
- 5a951c9
- Location:
- doc/started
- Files:
-
- 1 deleted
- 7 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/started/ChangeLog
r5a951c9 r4a675a5c 1 2002-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 1 7 2002-11-13 Joel Sherrill <joel@OARcorp.com> 2 8 -
doc/started/Makefile.am
r5a951c9 r4a675a5c 53 53 54 54 $(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" \ 56 56 -u "Top" \ 57 57 -n "Where To Go From Here" < $< > $@ … … 67 67 -n "" < $< > $@ 68 68 69 EXTRA_DIST = binaries.t buildc.t buildrt.t gdb.tintro.t nextstep.t nt.t \69 EXTRA_DIST = binaries.t buildc.t buildrt.t intro.t nextstep.t nt.t \ 70 70 require.t sample.t -
doc/started/buildc.t
r5a951c9 r4a675a5c 116 116 117 117 NOTE: This step is required if building BINUTILS, GCC, and NEWLIB 118 using the procedure s described in @ref{Using configure and make}119 or @ref{Using the bit Script}.It is @b{NOT} required if using the procedure118 using the procedure described in @ref{Using configure and make}. 119 It is @b{NOT} required if using the procedure 120 120 described in @ref{Using RPM to Build BINUTILS GCC and NEWLIB}. 121 121 … … 170 170 @end example 171 171 172 @c @ifset use-html173 @c @html174 @c <IMG SRC="bit_c.jpg" WIDTH=816 HEIGHT=267 ALT="Directory Organization">175 @c @end html176 @c @end ifset177 178 172 @c 179 173 @c Applying RTEMS Patches … … 183 177 184 178 NOTE: 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 procedure179 using the procedures described in @ref{Using configure and make}. 180 It is @b{NOT} required if using the procedure 187 181 described in @ref{Using RPM to Build BINUTILS GCC and NEWLIB}. 188 182 … … 298 292 @subsection Compiling and Installing BINUTILS GCC and NEWLIB 299 293 300 There are three methods to compile and install BINUTILS, GCC, and NEWLIB: 294 There are two supported methods to compile and install BINUTILS, GCC, 295 and NEWLIB: 301 296 302 297 @itemize @bullet 303 298 @item RPM 304 299 @item direct invocation of @code{configure} and @code{make} 305 @item using the @code{bit} script306 300 @end itemize 307 301 … … 545 539 546 540 @c 547 @c Using the bit Script548 @c549 550 @subsubsection Using the bit Script551 552 NOTE: The procedures described in the following sections must553 be completed before this step:554 555 @itemize @bullet556 @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 itemize560 561 This section describes the process of building using the562 @code{bit} script. This script hides many of the details563 of building the tools but can be a hindrance if you564 encounter problems building the tools.565 566 @c567 @c Unarchiving the Build Scripts568 @c569 570 @subheading Unarchiving the Build Scripts571 572 While in the @code{tools} directory, unpack the compressed573 tar file for the build tools using the following command sequence:574 575 @example576 cd tools577 tar xzf ../archive/@value{BUILDTOOLS-TAR}578 @end example579 580 After the compressed tar file @value{BUILDTOOLS-TAR} has been unpacked, there581 will be a set of scripts in the tools directory along with582 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 hide585 the invocation of @code{configure} and @code{make} from you. They are:586 587 @itemize @bullet588 @item bit589 @item bit_gdb590 @item bit_rtems591 @item common.sh592 @item user.cfg593 @end itemize594 595 If @code{bit} is executed later in this process,596 it will automatically create this subdirectory:597 598 @itemize @bullet599 @item build-$@{CPU@}-tools600 @end itemize601 602 At this point, the tree should look something like the following figure:603 604 @example605 @group606 /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-RTEMSPATCH613 @value{GCC-RTEMSPATCH}614 @end ifset615 @ifset BINUTILS-RTEMSPATCH616 @value{BINUTILS-RTEMSPATCH}617 @end ifset618 @ifset NEWLIB-RTEMSPATCH619 @value{NEWLIB-RTEMSPATCH}620 @end ifset621 tools/622 @value{BINUTILS-UNTAR}/623 @value{GCC-UNTAR}/624 @value{NEWLIB-UNTAR}/625 bit626 bit_gdb627 bit_rtems628 common.sh629 user.cfg630 @end group631 @end example632 633 @c @ifset use-html634 @c @html635 @c <IMG SRC="bit_c.jpg" WIDTH=816 HEIGHT=267 ALT="Directory Organization">636 @c @end html637 @c @end ifset638 639 @c640 @c Localizing the Configuration641 @c642 643 @subheading Localizing the Configuration644 645 Edit the @code{user.cfg} file to alter the settings of various646 variables which are used to tailor the build process.647 Each of the variables set in @code{user.cfg} may be modified648 as described below:649 650 @table @code651 @item INSTALL_POINT652 is the location where you wish the GNU C/C++ cross compilation tools for653 RTEMS to be built. It is recommended that the directory chosen to receive654 these tools be named so that it is clear from which gcc distribution it655 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 subdirectory658 under the build directory. The build directory will be removed659 automatically upon successful completion of the build procedure.660 661 @item BINUTILS662 is the directory under tools that contains @value{BINUTILS-UNTAR}.663 For example:664 665 @example666 BINUTILS=@value{BINUTILS-UNTAR}667 @end example668 669 @item GCC670 is the directory under tools that contains @value{GCC-UNTAR}.671 For example,672 673 @example674 GCC=@value{GCC-UNTAR}675 @end example676 677 @item GDB678 is the directory under tools that contains @value{GDB-UNTAR}.679 For example,680 681 @example682 GDB=@value{GDB-UNTAR}683 @end example684 685 @item NEWLIB686 is the directory under tools that contains @value{NEWLIB-UNTAR}.687 For example:688 689 @example690 NEWLIB=@value{NEWLIB-UNTAR}691 @end example692 693 @item BUILD_DOCS694 is set to "yes" if you want to install documentation. This requires695 that tools supporting documentation production be installed. This696 currently is limited to the GNU texinfo package.697 For example:698 699 @example700 BUILD_DOCS=yes701 @end example702 703 @item BUILD_OTHER_LANGUAGES704 is set to "yes" if you want to build languages other than C and C++. At705 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 @example712 BUILD_OTHER_LANGUAGES=yes713 @end example714 715 @b{NOTE:} Based upon the version of the compiler being used, it may not716 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 the718 executable code in these libraries will be for the default compiler settings719 and not necessarily be correct for your CPU model.720 721 @end table722 723 The other variables in @code{user.cfg} are RTEMS specific and are724 not technically required to be set unless you build RTEMS using725 the @code{bit_rtems} script as described in726 @ref{Using the bit_rtems Script}. They are described in detail727 in that section.728 729 @c730 @c Running the bit Script731 @c732 @subheading Running the bit Script733 734 After the @code{bit} script has been modified to reflect the735 local installation, the modified @code{bit} script is run736 using the following sequence:737 738 @example739 cd tools740 ./bit <target configuration>741 @end example742 743 Where <target configuration> is one of the following:744 745 @itemize @bullet746 @item hppa1.1747 @item i386748 @item i386-coff749 @item i386-elf750 @item i960751 @item m68k752 @item m68k-coff753 @item mips64orion754 @item powerpc755 @item sh756 @item sh-elf757 @item sparc758 @end itemize759 760 The build process can take a while to complete. Many users find it761 handy to run the build process in the background, capture the output762 in a file, and monitor the output. This can be done as follows:763 764 @example765 ./bit <target configuration> >bit.log 2>&1 &766 tail -f bit.log767 @end example768 769 If no errors are encountered, the @code{bit} script will conclude by770 printing messages similar to the following:771 772 @example773 774 The build-i386-tools subdirectory may now be removed.775 776 Started: Fri Apr 10 10:14:07 CDT 1998777 Finished: Fri Apr 10 12:01:33 CDT 1998778 @end example779 780 If the @code{bit} script successfully completes, then the781 GNU C/C++ cross compilation tools are installed.782 783 If the @code{bit} script does not successfully complete, then investigation784 will be required to determine the source of the error.785 786 @c -------------------787 788 @c789 541 @c Building the GNU Debugger GDB 790 542 @c … … 920 672 @item RPM 921 673 @item direct invocation of @code{configure} and @code{make} 922 @item using the @code{bit_gdb} script923 674 @end itemize 924 675 … … 1045 796 @code{--help} option. 1046 797 1047 @subsubsection Using the bit_gdb Script1048 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 to1051 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 @example1058 ./bit_gdb CPU1059 @end example1060 1061 Where CPU is one of the RTEMS supported CPU families from the following1062 list:1063 1064 @itemize @bullet1065 @item hppa1.11066 @item i3861067 @item i386-coff1068 @item i386-elf1069 @item i9601070 @item m68k1071 @item m68k-coff1072 @item mips64orion1073 @item powerpc1074 @item sh1075 @item sh-elf1076 @item sparc1077 @end itemize1078 1079 If gdb supports a CPU instruction simulator for this configuration, then1080 it is included in the build.1081 1082 @c -------------------1083 1084 798 @c 1085 799 @c Common Problems -
doc/started/buildrt.t
r5a951c9 r4a675a5c 120 120 This section describes how to configure and build RTEMS 121 121 so that it is specifically tailored for your BSP and the 122 CPU model it uses. There are two methods to compile and install RTEMS: 122 CPU model it uses. There is currently only one supported 123 method to compile and install RTEMS: 123 124 124 125 @itemize @bullet 125 126 @item direct invocation of @code{configure} and @code{make} 126 @item using the @code{bit} script127 127 @end itemize 128 128 129 129 Direct invocation of @code{configure} and @code{make} provides more control 130 and easier recovery from problems when building. 130 and easier recovery from problems when building. 131 131 132 132 This section describes how to build RTEMS. … … 169 169 tools and is @code{/opt/rtems} when using prebuilt toolset executables. 170 170 171 NOTE: The @code{make} utility used should be GNU make.172 173 @c174 @c Using the bit_rtems Script175 @c176 177 @subsection Using the bit_rtems Script178 179 If you have not previously unarchived the build tools, then you180 will need to unarchive the build scripts at this point if you181 plan to use @code{bit_rtems} to build RTEMS. If this is the182 case, you will have to execute the following additional command183 since you did not do it as part of building the tools.184 185 @example186 cd tools187 tar xzf ../archive/@value{BUILDTOOLS-TAR}188 @end example189 190 This script interprets the settings in the @code{user.cfg} file to191 enable or disable the various RTEMS options. The RTEMS192 specific entries described below must be set to193 tailor the RTEMS configuration to meet your application requirements:194 195 @table @code196 197 @item RTEMS198 is the directory under tools that contains @value{RTEMS-UNTAR}.199 200 @item ENABLE_RTEMS_POSIX201 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 RTEMS203 and is forced to "no" for those targets. This corresponds to the204 @code{configure} option @code{--enable-posix}.205 206 @item ENABLE_RTEMS_ITRON207 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 RTEMS209 and is forced to "no" for those targets. This corresponds to the210 @code{configure} option @code{--enable-itron}.211 212 @item ENABLE_RTEMS_MP213 is set to "yes" if you want to enable the RTEMS multiprocessing214 support. This feature is not supported by all RTEMS BSPs and215 is automatically forced to "no" for those BSPs. This corresponds to the216 @code{configure} option @code{--enable-multiprocessing}.217 218 @item ENABLE_RTEMS_CXX219 is set to "yes" if you want to build the RTEMS C++ support including220 the C++ Wrapper for the Classic API. This corresponds to the221 @code{configure} option @code{--enable-cxx}.222 223 @item ENABLE_RTEMS_TESTS224 is set to "yes" if you want to build the RTEMS Test Suite. If this225 is set to "no", then only the Sample Tests will be built. Setting226 this option to "yes" significantly increases the amount of disk227 space required to build RTEMS.228 This corresponds to the @code{configure} option @code{--enable-tests}.229 230 @item ENABLE_RTEMS_TCPIP231 is set to "yes" if you want to build the RTEMS TCP/IP Stack. If a232 particular BSP does not support TCP/IP, then this feature is automatically233 disabled. This corresponds to the @code{configure} option234 @code{--enable-tcpip}.235 236 @item ENABLE_RTEMS_NONDEBUG237 is set to "yes" if you want to build RTEMS in a fully optimized238 state. This corresponds to executing @code{make} after configuring239 the source tree.240 241 @item ENABLE_RTEMS_DEBUG242 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 to244 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 optimization247 level. This is usually done to reduce inlining which can make248 tracing code execution difficult. This corresponds to executing249 @code{make VARIANT=debug} after configuring250 the source tree.251 252 @item INSTALL_RTEMS253 is set to "yes" if you want to install RTEMS after building it.254 This corresponds to executing @code{make install} after configuring255 and building the source tree.256 257 @item ENABLE_RTEMS_MAINTAINER_MODE258 is set to "yes" if you want to enabled maintainer mode functionality259 in the RTEMS Makefile. This is disabled by default and it is not260 expected that most users will want to enable this. When this option261 is enabled, the build process may attempt to regenerate files that262 require tools not required when this option is disabled.263 This corresponds to the @code{configure} option264 @code{--enable-maintainer-mode}.265 266 @end table267 268 After tailoring @code{user.cfg} for your application, the @code{bit_rtems}269 script may be invoked as follows:270 271 @example272 ./bit_rtems CPU [BSP]273 @end example274 275 Where CPU is one of the RTEMS supported CPU families from the following276 list:277 278 @itemize @bullet279 @item hppa1.1280 @item i386281 @item i386-coff282 @item i386-elf283 @item i960284 @item m68k285 @item m68k-coff286 @item mips64orion287 @item powerpc288 @item sh289 @item sh-elf290 @item sparc291 @end itemize292 293 171 BSP is a supported BSP for the selected CPU family. The list of 294 172 supported BSPs may be found in the file … … 299 177 @b{NOTE:} The POSIX API must be enabled to use GNAT/RTEMS. 300 178 179 @b{NOTE:} The @code{make} utility used should be GNU make. 180 -
doc/started/nt.t
r5a951c9 r4a675a5c 44 44 45 45 @item If you want to build the tools from source, you have the 46 same options as UNIX users -- @code{bit} or @code{RPM}.46 same options as UNIX users. 47 47 48 48 @end itemize … … 280 280 281 281 Replace @code{m68k-rtems} with the target configuration 282 of your choice. See @ref{Using the bit Script} for a282 of your choice. See @ref{Using the RTEMS configure Script Directly} for a 283 283 list of the targets available. 284 284 … … 358 358 359 359 Replace @code{m68k-rtems} with the target configuration 360 of your choice. See @ref{Using the bit Script} for a360 of your choice. See @ref{Using the RTEMS configure Script Directly} for a 361 361 list of the targets available. 362 362 -
doc/started/require.t
r5a951c9 r4a675a5c 121 121 @item The build scripts are written in "shell". The program @code{/bin/sh} 122 122 on 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. 123 are on a Solaris 2.x host, then use the @code{/bin/ksh} or 124 @code{/bin/bash} shell instead. 126 125 127 126 @item The native @code{patch} program is broken. Install the GNU version. -
doc/started/tversions.texi
r5a951c9 r4a675a5c 22 22 @c 23 23 24 @set GCC-VERSION gcc 3. 125 @set GCC-TAR gcc-3. 1.tar.gz26 @set GCC-UNTAR gcc-3. 124 @set GCC-VERSION gcc 3.2 25 @set GCC-TAR gcc-3.2.tar.gz 26 @set GCC-UNTAR gcc-3.2 27 27 @set GCC-FTPSITE gcc.gnu.org 28 28 @set GCC-FTPDIR /pub/gnu/gcc/ 29 29 @set GCC-HTTPDIR /pub/gcc/releases/index.html 30 @set GCC-RTEMSPATCH gcc-3. 1-rtems-200205XX.diff.gz30 @set GCC-RTEMSPATCH gcc-3.2-rtems-20021107.diff 31 31 32 32 @c … … 35 35 36 36 @c The "official" binutils 37 @set BINUTILS-VERSION binutils 2.1 238 @set BINUTILS-TAR binutils-2.1 2.tar.gz39 @set BINUTILS-UNTAR binutils-2.1 237 @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 40 40 @set BINUTILS-FTPSITE ftp.gnu.org 41 41 @set BINUTILS-FTPDIR /pub/gnu/binutils … … 68 68 @set NEWLIB-FTPSITE sources.redhat.com 69 69 @set NEWLIB-FTPDIR /pub/newlib 70 @set NEWLIB-RTEMSPATCH newlib-1.10.0-rtems-2002 05XX.diff.gz70 @set NEWLIB-RTEMSPATCH newlib-1.10.0-rtems-20021101.diff.gz 71 71 72 72 @c … … 85 85 @c 86 86 87 @set RTEMS-VERSION RTEMS SS-2002 06XX88 @set RTEMS-TAR rtems-ss-2002 06xx.tgz89 @set RTEMS-UNTAR rtems-ss-2002 06xx87 @set RTEMS-VERSION RTEMS SS-20021111 88 @set RTEMS-TAR rtems-ss-20021111.tar.bz2 89 @set RTEMS-UNTAR rtems-ss-20021111 90 90 @set RTEMS-FTPSITE ftp.OARcorp.com 91 @set RTEMS-FTPDIR /pub/rtems/ releases/4.5.192 @ set BUILDTOOLS-TAR c_build_scripts-4.5.1.tgz91 @set RTEMS-FTPDIR /pub/rtems/cd-working 92 @c @set BUILDTOOLS-TAR c_build_scripts-4.5.1.tgz 93 93 94 94
Note: See TracChangeset
for help on using the changeset viewer.