source: rtems/doc/relnotes/intro.texi @ b8ed5c43

4.104.114.84.9
Last change on this file since b8ed5c43 was b8ed5c43, checked in by Joel Sherrill <joel.sherrill@…>, on Sep 29, 2004 at 8:21:37 PM

2004-09-29 Joel Sherrill <joel@…>

  • intro.texi, status.texi: i960 obsoleted.
  • Property mode set to 100644
File size: 6.5 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-2002.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@ifinfo
10@node Introduction, Introduction Supporting Tools, Top, Top
11@end ifinfo
12@chapter Introduction
13@ifinfo
14@menu
15* Introduction Supporting Tools::
16* Introduction Documentation::
17@end menu
18@end ifinfo
19
20This document describes the contents, installation
21procedure, and current status of Release @value{VERSION} of the RTEMS
22executive.  An installation procedure is provided which
23describes the steps necessary to load and configure the RTEMS
24environment, including the GNU Development Environment and the
25Cygnus NEWLIB ANSI C Library, on a host computer.  The status of
26the RTEMS environment is given, which includes supported
27processors and target boards, versions of the GNU utilities
28which were used by the RTEMS developers for this release,
29support libraries status, features which are not implemented,
30and any known existing problems.
31
32This RTEMS release package contains the following general components:
33
34@itemize @bullet
35@item RTEMS C Executive
36
37@item RTEMS C Documentation Set
38
39@item RTEMS NEWLIB ANSI C Library
40
41@item Patches to GNU Development Tools
42
43@end itemize
44
45There is a mailing list dedicated to RTEMS.  This is
46a Majordomo style mailing list and may be subscribed to
47by sending a message to rtems-list-request@@rtems.com with
48the following line as the body:
49
50@example
51subscribe rtems_user@@your_email_goes_here.com
52@end example
53
54Please replace rtems_user@@your_email_goes_here.com with your
55email address.
56
57@ifinfo
58@node Introduction Supporting Tools, GNU Development Tools, Introduction, Introduction
59@end ifinfo
60@section Supporting Tools
61@ifinfo
62@menu
63* GNU Development Tools::
64* ANSI C Libraries::
65* GNU C Library::
66* Cygnus NEWLIB C Library::
67@end menu
68@end ifinfo
69
70This section discusses the freely available tools and
71libraries which are part of the RTEMS Development Environment.
72None of the tools discussed in this section were developed by
73the RTEMS project, although many do include submissions from the
74project.  All of the tools and libraries required to build RTEMS
75are freely available.  The home ftp site for most of the non-RTEMS
76specific tools is either prep.ai.mit.edu (18.71.0.38) or
77ftp.cygnus.com (140.174.1.3).
78
79Specifically of interest to embedded systems developers
80using the GNU tools is the crossgcc mailing list.  This is
81a Majordomo style mailing list and may be subscribed to
82by sending a message to crossgcc-request@@cygnus.com with
83the following line as the body:
84
85@example
86subscribe rtems_user@@your_email_goes_here.com
87@end example
88
89Please replace rtems_user@@your_email_goes_here.com with your
90email address.  The FAQ for crossgcc is in the /pub/embedded/crossgcc
91directory on ftp.cygnus.com (205.180.83.42).
92
93@ifinfo
94@node GNU Development Tools, ANSI C Libraries, Introduction Supporting Tools, Introduction Supporting Tools
95@end ifinfo
96@subsection GNU Development Tools
97
98Numerous GNU tools are used in the RTEMS Development
99Environment including C and Ada compilers, the GNU make program,
100GNU m4, the GNU assembler and binary utilities (linker,
101librarian, etc.), GNU tar, GNU zip, and the GNU debugger.  These
102tools are distributed in source form and are all licensed under
103the GNU Public License which allows for unrestricted
104distribution under the condition that source code always be
105available.  The Free Software Foundation is officially the
106originator of most of the GNU tools although many individuals
107have contributed to the GNU projects.  In keeping with the
108spirit of the GPL,  most of the time the GNU tools are
109distributed as source code without executables.  It is the
110responsibility of the local site to install each tool.  Numerous
111organizations and individuals supply executables for the GNU
112tools.  All are required by the terms of the GPL to also make
113the source code available to the end user.
114
115The primary ftp site for the FSF GNU tools is
116prep.ai.mit.edu (18.71.0.38) in the /pub/gnu directory.  These
117tools are mirrored on numerous ftp sites.
118
119Cygnus maintains an ftp site -- ftp.cygnus.com
120(205.180.83.42) -- which contains a source code which appeals to
121embedded developers.  Of especial interest on this site are the
122directories /pub/newlib and /pub/embedded.
123
124@ifinfo
125@node ANSI C Libraries, GNU C Library, GNU Development Tools, Introduction Supporting Tools
126@end ifinfo
127@subsection ANSI C Libraries
128
129This section discusses the following freely
130distributable ANSI C Libraries:
131
132@itemize @bullet
133@item GNU C Library, and
134
135@item Cygnus NEWLIB
136@end itemize
137
138No C Library is included in the standard RTEMS
139distribution.  It is the responsibility of the user to obtain
140and install a C Library separately.
141
142@ifinfo
143@node GNU C Library, Cygnus NEWLIB C Library, ANSI C Libraries, Introduction Supporting Tools
144@end ifinfo
145@subsection GNU C Library
146
147The GNU C Library is a robust and well-documented C
148Library which is distributed under the terms of the Library GNU
149Public License (LGPL).  This library was not designed for use in
150real-time, embedded systems and the resource requirements of
151some of the routines in this library are an obvious indication
152of this.  Additionally, this library does not have support for
153reentrancy in the sense that each task in a multitasking system
154could safely invoke every routine in the library.  Finally, the
155distribution terms of the LGPL are considered undesirable by
156many embedded systems developers.  However, the GNU C Library is
157very complete and is compliant with as many standards as
158possible.  Because of this, it may be the only choice for many
159developers.
160
161There is currently no RTEMS support for the GNU C Library.
162
163The primary ftp site for this library is
164prep.ai.mit.edu (18.71.0.38).
165
166@ifinfo
167@node Cygnus NEWLIB C Library, Introduction Documentation, GNU C Library, Introduction Supporting Tools
168@end ifinfo
169@subsection Cygnus NEWLIB C Library
170
171The Cygnus NEWLIB C Library was specifically designed
172for real-time embedded systems.  It is a small, reasonably
173documented Library with support for reentrancy.  This library is
174a collection of freely distributable and public domain source
175code and is freely distributable with as few restrictions as
176possible placed on the end user.
177
178The primary ftp site for this library is ftp.cygnus.com (205.180.83.42).
179
180@ifinfo
181@node Introduction Documentation, Installation Procedure, Cygnus NEWLIB C Library, Introduction
182@end ifinfo
183@section Documentation
184
185The RTEMS Documentation Set is provided online at
186@uref{http://www.rtems.com/onlinedocs.html}
187as reference information for all levels of RTEMS users. 
188
189The RTEMS documentation set is available in HTML, PostScript, PDF, and DVI.
Note: See TracBrowser for help on using the repository browser.