summaryrefslogtreecommitdiffstats
path: root/doc/started/buildrt.t
diff options
context:
space:
mode:
Diffstat (limited to 'doc/started/buildrt.t')
-rw-r--r--doc/started/buildrt.t130
1 files changed, 5 insertions, 125 deletions
diff --git a/doc/started/buildrt.t b/doc/started/buildrt.t
index 0ab4d00287..2e31b12154 100644
--- a/doc/started/buildrt.t
+++ b/doc/started/buildrt.t
@@ -119,15 +119,15 @@ error messages.
This section describes how to configure and build RTEMS
so that it is specifically tailored for your BSP and the
-CPU model it uses. There are two methods to compile and install RTEMS:
+CPU model it uses. There is currently only one supported
+method to compile and install RTEMS:
@itemize @bullet
@item direct invocation of @code{configure} and @code{make}
-@item using the @code{bit} script
@end itemize
Direct invocation of @code{configure} and @code{make} provides more control
-and easier recovery from problems when building.
+and easier recovery from problems when building.
This section describes how to build RTEMS.
@@ -168,128 +168,6 @@ tools/@value{RTEMS-UNTAR}/README.configure.
<INSTALL_POINT> is typically the installation point for the
tools and is @code{/opt/rtems} when using prebuilt toolset executables.
-NOTE: The @code{make} utility used should be GNU make.
-
-@c
-@c Using the bit_rtems Script
-@c
-
-@subsection Using the bit_rtems Script
-
-If you have not previously unarchived the build tools, then you
-will need to unarchive the build scripts at this point if you
-plan to use @code{bit_rtems} to build RTEMS. If this is the
-case, you will have to execute the following additional command
-since you did not do it as part of building the tools.
-
-@example
-cd tools
-tar xzf ../archive/@value{BUILDTOOLS-TAR}
-@end example
-
-This script interprets the settings in the @code{user.cfg} file to
-enable or disable the various RTEMS options. The RTEMS
-specific entries described below must be set to
-tailor the RTEMS configuration to meet your application requirements:
-
-@table @code
-
-@item RTEMS
-is the directory under tools that contains @value{RTEMS-UNTAR}.
-
-@item ENABLE_RTEMS_POSIX
-is set to "yes" if you want to enable the RTEMS POSIX API support.
-At this time, this feature is not supported by the UNIX ports of RTEMS
-and is forced to "no" for those targets. This corresponds to the
-@code{configure} option @code{--enable-posix}.
-
-@item ENABLE_RTEMS_ITRON
-is set to "yes" if you want to enable the RTEMS ITRON API support.
-At this time, this feature is not supported by the UNIX ports of RTEMS
-and is forced to "no" for those targets. This corresponds to the
-@code{configure} option @code{--enable-itron}.
-
-@item ENABLE_RTEMS_MP
-is set to "yes" if you want to enable the RTEMS multiprocessing
-support. This feature is not supported by all RTEMS BSPs and
-is automatically forced to "no" for those BSPs. This corresponds to the
-@code{configure} option @code{--enable-multiprocessing}.
-
-@item ENABLE_RTEMS_CXX
-is set to "yes" if you want to build the RTEMS C++ support including
-the C++ Wrapper for the Classic API. This corresponds to the
-@code{configure} option @code{--enable-cxx}.
-
-@item ENABLE_RTEMS_TESTS
-is set to "yes" if you want to build the RTEMS Test Suite. If this
-is set to "no", then only the Sample Tests will be built. Setting
-this option to "yes" significantly increases the amount of disk
-space required to build RTEMS.
-This corresponds to the @code{configure} option @code{--enable-tests}.
-
-@item ENABLE_RTEMS_TCPIP
-is set to "yes" if you want to build the RTEMS TCP/IP Stack. If a
-particular BSP does not support TCP/IP, then this feature is automatically
-disabled. This corresponds to the @code{configure} option
-@code{--enable-tcpip}.
-
-@item ENABLE_RTEMS_NONDEBUG
-is set to "yes" if you want to build RTEMS in a fully optimized
-state. This corresponds to executing @code{make} after configuring
-the source tree.
-
-@item ENABLE_RTEMS_DEBUG
-is set to "yes" if you want to build RTEMS in a debug version.
-When built for debug, RTEMS will include run-time code to
-perform consistency checks such as heap consistency checks.
-Although the precise compilation arguments are BSP dependent,
-the debug version of RTEMS is usually built at a lower optimization
-level. This is usually done to reduce inlining which can make
-tracing code execution difficult. This corresponds to executing
-@code{make VARIANT=debug} after configuring
-the source tree.
-
-@item INSTALL_RTEMS
-is set to "yes" if you want to install RTEMS after building it.
-This corresponds to executing @code{make install} after configuring
-and building the source tree.
-
-@item ENABLE_RTEMS_MAINTAINER_MODE
-is set to "yes" if you want to enabled maintainer mode functionality
-in the RTEMS Makefile. This is disabled by default and it is not
-expected that most users will want to enable this. When this option
-is enabled, the build process may attempt to regenerate files that
-require tools not required when this option is disabled.
-This corresponds to the @code{configure} option
-@code{--enable-maintainer-mode}.
-
-@end table
-
-After tailoring @code{user.cfg} for your application, the @code{bit_rtems}
-script may be invoked as follows:
-
-@example
-./bit_rtems CPU [BSP]
-@end example
-
-Where CPU is one of the RTEMS supported CPU families from the following
-list:
-
-@itemize @bullet
-@item hppa1.1
-@item i386
-@item i386-coff
-@item i386-elf
-@item i960
-@item m68k
-@item m68k-coff
-@item mips64orion
-@item powerpc
-@item sh
-@item sh-elf
-@item sparc
-@end itemize
-
BSP is a supported BSP for the selected CPU family. The list of
supported BSPs may be found in the file
tools/@value{RTEMS-UNTAR}/README.configure
@@ -298,3 +176,5 @@ then all supported BSPs for the selected CPU family will be built.
@b{NOTE:} The POSIX API must be enabled to use GNAT/RTEMS.
+@b{NOTE:} The @code{make} utility used should be GNU make.
+