Mirrors_Framework/rtems
1
0 Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-11-08 00:40:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc/started: simplify and fix

Browse Source 
* fix and remove some macros in rtems.texi.in.
* refer to devel mailing list.
* remove reference to Debian packaging in requirements section.
* remove section on prebuilt tools.
* replace toolset build instructions with link to RSB docs.
* Add a note in building RTEMS section about using RSB.
* Fix URLs

Closes #2291.
This commit is contained in:
Gedare Bloom committed 2015-03-11 13:39:29 -04:00
1 parent cf4045630e
commit d84995d28c
8 files changed
+47 -1226
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/common/rtems.texi.in
+2 -5
View File
@@ -1,8 +1,5 @@
@set RTEMSHTTPSITE www.rtems.org
@set RTEMSUSERS rtems-users@@rtems.com
@set RTEMSUSERSSUBSCRIBE rtems-users-subscribe@@rtems.com
@set RTEMSBUGS http://www.rtems.org/bugzilla
@set RTEMSFTPURL ftp://www.rtems.org
@set RTEMSUSERS users@@rtems.org
@set RTEMSDEVEL devel@@rtems.org
@set RTEMSHTTPURL http://www.rtems.org
@set RTEMSPREFIX @RTEMSPREFIX@
@set RTEMSAPI @RTEMSAPI@
doc/started/Makefile.am
+8 -12
View File
@@ -8,7 +8,7 @@ PROJECT = started
include $(top_srcdir)/project.am
include $(top_srcdir)/main.am
GENERATED_FILES = binaries.texi buildc.texi buildrt.texi intro.texi nt.texi \
GENERATED_FILES = buildc.texi buildrt.texi intro.texi nt.texi \
require.texi nextstep.texi sample.texi
COMMON_FILES += $(top_srcdir)/common/cpright.texi
@@ -24,23 +24,19 @@ intro.texi: intro.t
-n "Requirements" < $< > $@
require.texi: require.t
$(BMENU2) -c -p "GCC Mailing Lists" \
$(BMENU2) -c -p "RTEMS Mailing Lists" \
-u "Top" \
-n "Prebuilt Toolset Executables" < $< > $@
binaries.texi: binaries.t
$(BMENU2) -c \
-p "GNU/Linux Distributions using Debian Packaging Format" \
-u "Top" \
-n "Building the GNU Cross Compiler Toolset" < $< > $@
-n "Building the GNU Cross Compiler Toolset with RSB" < $< > $@
buildc.texi: buildc.t
$(BMENU2) -c -p "Removing Zipped Tar Files" \
$(BMENU2) -c \
-p "Distribution Independent Potential GNU/Linux Issues" \
-u "Top" \
-n "Building RTEMS" < $< > $@
buildrt.texi: buildrt.t
$(BMENU2) -c -p "Error Messages Indicating Configuration Problems" \
$(BMENU2) -c \
-p "Building the GNU Cross Compiler Toolset with RSB" \
-u "Top" \
-n "Building the Sample Applications" < $< > $@
@@ -59,7 +55,7 @@ nt.texi: nt.t
-u "Top" \
-n "" < $< > $@
EXTRA_DIST = binaries.t buildc.t buildrt.t intro.t nextstep.t nt.t require.t \
EXTRA_DIST = buildc.t buildrt.t intro.t nextstep.t nt.t require.t \
sample.t
if USE_HTML
doc/started/binaries.t
-341
View File
File diff suppressed because it is too large. Load diff
doc/started/buildc.t
+8 -821
View File
File diff suppressed because it is too large. Load diff
doc/started/buildrt.t
+16 -12
View File
@@ -5,6 +5,11 @@
@chapter Building RTEMS
@b{NOTE}: If you built your toolset with RSB, by default the RSB also
builds RTEMS while building the compiler toolset. You may already have
a built and installed RTEMS in this case, and if not you should check
the RSB documentation at @uref{https://docs.rtems.org/rsb/,https://docs.rtems.org/rsb/}.
@section Obtain the RTEMS Source Code
This section provides pointers to the RTEMS source code and example
@@ -14,8 +19,8 @@ directory whose name is the release on the ftp site. The RTEMS ftp site
is accessible via both the ftp and http protocols at the following URLs:
@itemize @bullet
@item @uref{http://www.rtems.org/ftp/pub/rtems,http://www.rtems.org/ftp/pub/rtems}
@item @uref{ftp://www.rtems.org/pub/rtems,ftp://www.rtems.org/pub/rtems}
@item @uref{http://ftp.rtems.org/pub/rtems,http://ftp.rtems.org/pub/rtems}
@item @uref{ftp://ftp.rtems.org/pub/rtems,ftp://ftp.rtems.org/pub/rtems}
@end itemize
Associated with each RTEMS Release is a set of example programs.
@@ -47,7 +52,7 @@ Instead of downloading release tarballs you may choose to check out the current
RTEMS source from the project's source code repository. For details on
accessing the RTEMS source repository consult:
@uref{http://wiki.rtems.org/wiki/index.php/RTEMS_GIT_Repository, http://wiki.rtems.org/wiki/index.php/RTEMS_GIT_Repository}.
@uref{https://devel.rtems.org/wiki/Developer/Git,https://devel.rtems.org/wiki/Developer/Git}.
@section Add <INSTALL_POINT>/bin to Executable PATH
@@ -56,8 +61,8 @@ in your search path. It is important to have the RTEMS toolset first
in your path to ensure that you are using the intended version of all
tools. The following command prepends the directory where
the tools were installed in a previous step. If you are using
binaries provided by the RTEMS Project, the <INSTALL_POINT> will be
@code{/opt/rtems-@value{RTEMSAPI}}
binaries installed to @code{/opt/rtems-@value{RTEMSAPI}}, then the
<INSTALL_POINT> will be @code{/opt/rtems-@value{RTEMSAPI}}
@example
export PATH=<INSTALL_POINT>/bin:$@{PATH@}
@@ -106,11 +111,9 @@ m68k-rtems@code{RTEMSAPI}-gcc -v -c f.c
@end example
If this produces messages that indicate the assembly code is not valid,
then it is likely that you have fallen victim to one of the problems
described in @ref{Error Message Indicates Invalid Option to Assembler}
Please do not feel bad about this and do not give up, one of the most
common installation errors is for the cross-compiler not to be able
to find the cross assembler and default to using the native @code{as}.
then it is likely that you have fallen victim to one of the most
common installation errors and the cross-compiler is not able
to find the cross assembler and defaults to using the native @code{as}.
This can result in very confusing error messages.
@section Building RTEMS for a Specific Target and BSP
@@ -162,8 +165,9 @@ the @code{BOARD_SUPPORT_PACKAGE} board.
@example
mkdir build-rtems
cd build-rtems
../rtems-@value{RTEMSAPI}.VERSION/configure --target=<TARGET_CONFIGURATION> \
--disable-posix --disable-networking --disable-cxx \
../rtems-@value{RTEMSAPI}.VERSION/configure \
--target=<TARGET_CONFIGURATION> \
--disable-networking \
--enable-rtemsbsp=<BSP>\
--prefix=<INSTALL_POINT>
make all
doc/started/intro.t
+12 -25
View File
@@ -136,37 +136,24 @@ The RTEMS Project provides formatted documentation for the primary
tools in the cross development toolset including BINUTILS, GCC,
NEWLIB, and GDB with the pre-built versions of those tools.
Much of the documentation is available at other sites on the Internet.
The following is a list of URLs where one can find HTML versions of
the GNU manuals:
Much of the documentation is available at other sites on the Internet,
for example the GNU manuals are hosted by the Free Software Foundation
at @uref{http://www.gnu.org/manual/manual.html, http://www.gnu.org/manual/manual.html}.
@table @b
@item Free Software Foundation
@uref{http://www.gnu.org/manual/manual.html,
http://www.gnu.org/manual/manual.html}
@item Delorie Software
@uref{http://www.delorie.com/gnu/docs, http://www.delorie.com/gnu/docs}
@end table
@subsection RTEMS Mailing List
@subsection RTEMS Mailing Lists
@uref{mailto:@value{RTEMSUSERS},@value{RTEMSUSERS}}
This is the primary mailing list for the discussion of issues
related to RTEMS, including GNAT/RTEMS. If you have questions
about RTEMS, wish to make suggestions, track development efforts,
or just want to pick up hints, this is a good list to monitor.
The users mailing list is for any and all questions about RTEMS, especially
those focusing on how to use RTEMS.
If you would like to browse the thousands of messages in the fifteen
year archive of the mailing list or subscribe to it, please visit
@uref{http://www.rtems.org/mailman,http://www.rtems.org/mailman} for
@uref{https://lists.rtems.org/mailman/listinfo/users,https://lists.rtems.org/mailman/listinfo/users} for
more information,
@subsection GCC Mailing Lists
@uref{mailto:@value{RTEMSDEVEL},@value{RTEMSDEVEL}}
The devel mailing list is the place to track ongoing RTEMS development
and to discuss changes to RTEMS. This list is also where patches are
submitted.
The GCC Project is hosted at @uref{http://gcc.gnu.org,http://gcc.gnu.org}.
They maintain multiple mailing lists that are described at the web site
along with subscription information.
doc/started/require.t
-7
View File
@@ -152,10 +152,3 @@ to at least GNU fileutils version 3.16 to resolve this problem.
@end itemize
@subsection GNU/Linux Distributions using Debian Packaging Format
The RTEMS Project does not currently provide prebuilt toolsets in the Debian packaging format used by the Debian and Ubuntu distributions. If you are using a distribution using this packaging format, then you have two options for installing the RTEMS toolset.
The first option is to build the toolset from source following the instructions in the @ref{Building the GNU Cross Compiler Toolset}. This is an approach taken by many users.
Alternatively, it is often possible to extract the contents of the RPM files which contain the portions of the toolset you require. In this case, you will follow the instructions in @ref{Locating the RPMs for your GNU/Linux Distribution} but assume your distribution is the RedHat Enterprise Linux version which is closest to yours from a shared library perspective. As of December 2010, this is usually RedHat Enterprise Linux version 5. As time passes, it is expected that version 6 will be appropriate in more cases. You will extract the contents of these RPM files using either @code{rpm2cpio} and install them or you may be able to use the @code{alien} tool to convert them to Debian packaging.
doc/started/started.texi
+1 -3
View File
@@ -64,8 +64,7 @@ This is the online version of the Getting Started with RTEMS.
@menu
* Introduction::
* Requirements::
* Prebuilt Toolset Executables::
* Building the GNU Cross Compiler Toolset::
* Building the GNU Cross Compiler Toolset with RSB::
* Building RTEMS::
* Building the Sample Applications::
* Where To Go From Here::
@@ -77,7 +76,6 @@ This is the online version of the Getting Started with RTEMS.
@include intro.texi
@include require.texi
@include binaries.texi
@include buildc.texi
@include buildrt.texi
@include sample.texi