summaryrefslogtreecommitdiffstats
path: root/doc/relnotes
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2016-11-15 10:37:59 -0600
committerJoel Sherrill <joel@rtems.org>2017-01-11 12:13:21 -0600
commit48a7fa31f918a6fc88719b3c9393a9ba2829f42a (patch)
tree10bf638de133099fcabe5fe713ca98a546a27ab2 /doc/relnotes
parentRemove obsolete __RTEMS_HAVE_SYS_CPUSET_H__ (diff)
downloadrtems-48a7fa31f918a6fc88719b3c9393a9ba2829f42a.tar.bz2
Remove texinfo format documentation. Replaced by Sphinx formatted documentation.
closes #2812.
Diffstat (limited to 'doc/relnotes')
-rw-r--r--doc/relnotes/Makefile.am18
-rw-r--r--doc/relnotes/install.texi157
-rw-r--r--doc/relnotes/intro.texi147
-rw-r--r--doc/relnotes/probrep.texi57
-rw-r--r--doc/relnotes/relnotes.texi104
-rw-r--r--doc/relnotes/stamp-vti4
-rw-r--r--doc/relnotes/status.texi152
-rw-r--r--doc/relnotes/version.texi4
8 files changed, 0 insertions, 643 deletions
diff --git a/doc/relnotes/Makefile.am b/doc/relnotes/Makefile.am
deleted file mode 100644
index a0fce4f011..0000000000
--- a/doc/relnotes/Makefile.am
+++ /dev/null
@@ -1,18 +0,0 @@
-#
-# COPYRIGHT (c) 1988-2002.
-# On-Line Applications Research Corporation (OAR).
-# All rights reserved.
-
-PROJECT = relnotes
-
-include $(top_srcdir)/project.am
-include $(top_srcdir)/main.am
-
-COMMON_FILES += $(top_srcdir)/common/cpright.texi
-
-FILES = install.texi intro.texi probrep.texi relnotes.texi status.texi
-
-info_TEXINFOS = relnotes.texi
-relnotes_TEXINFOS = $(FILES) $(COMMON_FILES)
-
-CLEANFILES += relnotes.info
diff --git a/doc/relnotes/install.texi b/doc/relnotes/install.texi
deleted file mode 100644
index 969272c1fb..0000000000
--- a/doc/relnotes/install.texi
+++ /dev/null
@@ -1,157 +0,0 @@
-@c
-@c COPYRIGHT (c) 1989-2011.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
-
-@node Installation Procedure, Installation Procedure Introduction, Introduction Documentation, Top
-@chapter Installation Procedure
-@menu
-* Installation Procedure Introduction::
-* Installation Procedure RTEMS FTP Site Organization::
-* Installation Procedure Unarchiving the RTEMS and GNU Components::
-* Installation Procedure Installing a Cross-Development GNU Toolset::
-* Installation Procedure Installing RTEMS::
-@end menu
-
-@node Installation Procedure Introduction, Installation Procedure RTEMS FTP Site Organization, Installation Procedure, Installation Procedure
-@section Introduction
-
-This chapter describes the process of installing and
-configuring RTEMS and a cross-development environment based on
-freely available tools and libraries.
-
-@node Installation Procedure RTEMS FTP Site Organization, Installation Procedure Unarchiving the RTEMS and GNU Components, Installation Procedure Introduction, Installation Procedure
-@section RTEMS FTP Site Organization
-
-RTEMS is distributed only via anonymous ftp.
-
-This section will discuss how to navigate the RTEMS
-ftp site and unarchive the files in the RTEMS and GNU package
-distributions. All example commands will be given in a shell
-independent fashion unless otherwise noted.
-
-Throughout the rest of this manual
-<RTEMS_distribution> will be used as the parent of components
-within the RTEMS distribution. For persons using the ftp
-distribution found on the primary ftp site for RTEMS,
-<RTEMS_distribution> are found under this directory
-@uref{ftp://ftp.rtems.com/pub/rtems/}. HTTP access to the
-ftp site is available via @uref{http://www.rtems.org/ftp/pub/rtems}.
-
-The archive files for RTEMS Release @value{VERSION} are found
-under the directory <RTEMS_distribution>. This directory
-contains the files which comprise this relase as well as any
-patches which may be required for other tools.
-
-The complete source code and documentation set for
-the C language implementation of RTEMS is provided.
-
-@node Installation Procedure Unarchiving the RTEMS and GNU Components, Installation Procedure Installing a Cross-Development GNU Toolset, Installation Procedure RTEMS FTP Site Organization, Installation Procedure
-@section Unarchiving the RTEMS and GNU Components
-
-Many of the components of the RTEMS release are
-"tarred, zipped" files and have the .tar.gz or .tgz extension.
-The GNU zip package is required to unarchives these files on the
-RTEMS ftp site. If this package is not installed, the source
-can be found in the files
-@uref{ftp://ftp.gnu.org/pub/gnu/gzip/gzip-1.2.4.shar} or
-@uref{ftp://ftp.gnu.org/pub/gnu/gzip/gzip-1.2.4.tar}. It may be
-restored using a command similar to the following:
-
-@example
-@group
-tar xvf gzip-1.2.4.tar
-
-OR
-
-sh gzip-1.2.4.shar
-@end group
-@end example
-
-This will create a subdirectory gzip-1.2.4 in the
-current directory. Please examine the files README and INSTALL
-and follow the instructions provided there.
-
-[Note: The GNU tools follow a standard packaging procedure
-They will unarchive into a directory based on the package name and version
-number. For detailed instructions on compilation and
-installation of the GNU tools, please refer to the instructions for
-each GNU tool.]
-
-Files which have been "tarred, zipped" (i.e. .tar.gz
-or .tgz extension) may be unarchived with a command similar to
-one of the following:
-
-@example
-@group
-gzcat <file>.tgz | tar xvof -
-
-OR
-
-gunzip -c <file>.tgz | tar xvof -
-
-OR
-
-gtar xzvf <file>.tgz
-@end group
-@end example
-
-NOTE: gunzip -c is equivalent to gzcat, while gtar is GNU tar.
-
-Given that the necessary utility programs are
-installed, any of the above commands will extract the contents
-of <file>.tar.gz into the current directory. All of the RTEMS
-components will be extracted into the subdirectory rtems-@value{VERSION}.
-To view the contents of a component without restoring any files,
-use a command similar to the following:
-
-@example
-@group
-gzcat <file>.tgz | tar tvf -
-@end group
-@end example
-
-@node Installation Procedure Installing a Cross-Development GNU Toolset, Installation Procedure Installing RTEMS, Installation Procedure Unarchiving the RTEMS and GNU Components, Installation Procedure
-@section Installing a Cross-Development GNU Toolset
-
-This sections describes how to build and install the
-FSF GNU tools for use as a cross-compilation system. These
-tools are used by the RTEMS developers. Every effort has been
-made to make these instructions accurate and complete. However,
-it is recommended that the individual doing the installation
-read the appropriate installation notes for each of the tools in
-the cross toolset. This will help insure that there are no
-special requirements for a particular host.
-
-If the host and target processors are the same, then
-it may be possible to use the host development tools. An
-example of this scenario is using a SPARC based workstation
-to develop an RTEMS application for the SPARC processor. Although
-the native toolset is useable in this scenario, it is ultimately
-more desirable to build a toolset specifically for the embedded environment.
-
-Instructions for building a cross environment using the GNU
-tools is provided in the crossgcc FAQ available from ftp.cygnus.com
-in /pub/embedded/crossgcc. It is recommended that the user following
-these instructions.
-
-After the cross development toolset has been built
-and installed, it will be necessary to modify the environment of
-each RTEMS application developer to reflect at least the path of
-the newly installed cross development toolset.
-
-The documentation for the FSF GNU and open source tools is
-formatted using TeX. The RTEMS developers use TeX to
-format the manuals for their own use. This document does not
-contain instructions on the acquisition or installation of TeX
-and supporting tools.
-
-NOTE: For "UNIX" processors, the native compiler binary utilities
-should be used.
-
-@node Installation Procedure Installing RTEMS, Development Environment Status, Installation Procedure Installing a Cross-Development GNU Toolset, Installation Procedure
-@section Installing RTEMS
-
-For instructions on building and installing RTEMS, please refer to
-the file README.configure in the source distribution.
-
diff --git a/doc/relnotes/intro.texi b/doc/relnotes/intro.texi
deleted file mode 100644
index 30e0914be8..0000000000
--- a/doc/relnotes/intro.texi
+++ /dev/null
@@ -1,147 +0,0 @@
-@c
-@c COPYRIGHT (c) 1989-2014.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
-
-@node Introduction, Introduction Supporting Tools, Top, Top
-@chapter Introduction
-@menu
-* Introduction Supporting Tools::
-* Introduction Documentation::
-@end menu
-
-This document describes the contents, installation
-procedure, and current status of Release @value{VERSION} of the RTEMS
-executive. An installation procedure is provided which
-describes the steps necessary to load and configure the RTEMS
-environment, including the GNU Development Environment and the
-NEWLIB ANSI C Library, on a host computer. The status of
-the RTEMS environment is given, which includes supported
-processors and target boards, versions of the GNU utilities
-which were used by the RTEMS developers for this release,
-support libraries status, features which are not implemented,
-and any known existing problems.
-
-This RTEMS release package contains the following general components:
-
-@itemize @bullet
-@item RTEMS C Executive
-
-@item RTEMS C Documentation Set
-
-@item RTEMS NEWLIB ANSI C Library
-
-@item Patches to GNU Development Tools
-
-@end itemize
-
-There are multiple mailing lists dedicated to RTEMS.
-Each list may be subscribed to, archives view, etc. by visiting
-@uref{http://www.rtems.org/mailman/listinfo}.
-
-@node Introduction Supporting Tools, GNU Development Tools, Introduction, Introduction
-@section Supporting Tools
-@menu
-* GNU Development Tools::
-* ANSI C Libraries::
-* GNU C Library::
-* NEWLIB C Library::
-@end menu
-
-This section discusses the freely available tools and
-libraries which are part of the RTEMS Development Environment.
-None of the tools discussed in this section were developed by
-the RTEMS project, although many do include submissions from the
-project. All of the tools and libraries required to build RTEMS
-are freely available. The home ftp site for most of the non-RTEMS
-specific tools is either prep.ai.mit.edu (18.71.0.38) or
-ftp.cygnus.com (140.174.1.3).
-
-Specifically of interest to embedded systems developers
-using the GNU tools is the crossgcc mailing list. This is
-a Majordomo style mailing list and may be subscribed to
-by sending a message to crossgcc-request@@cygnus.com with
-the following line as the body:
-
-@example
-subscribe rtems_user@@your_email_goes_here.com
-@end example
-
-Please replace rtems_user@@your_email_goes_here.com with your
-email address. The FAQ for crossgcc is in the /pub/embedded/crossgcc
-directory on ftp.cygnus.com (205.180.83.42).
-
-@node GNU Development Tools, ANSI C Libraries, Introduction Supporting Tools, Introduction Supporting Tools
-@subsection GNU Development Tools
-
-Numerous GNU tools are used in the RTEMS Development
-Environment including C and Ada compilers, the GNU make program,
-GNU m4, the GNU assembler and binary utilities (linker,
-librarian, etc.), GNU tar, GNU zip, and the GNU debugger. These
-tools are distributed in source form and are all licensed under
-the GNU Public License which allows for unrestricted
-distribution under the condition that source code always be
-available. The Free Software Foundation is officially the
-originator of most of the GNU tools although many individuals
-have contributed to the GNU projects. In keeping with the
-spirit of the GPL, most of the time the GNU tools are
-distributed as source code without executables. It is the
-responsibility of the local site to install each tool. Numerous
-organizations and individuals supply executables for the GNU
-tools. All are required by the terms of the GPL to also make
-the source code available to the end user.
-
-The primary ftp site for the FSF GNU tools is
-prep.ai.mit.edu (18.71.0.38) in the /pub/gnu directory. These
-tools are mirrored on numerous ftp sites.
-
-@node ANSI C Libraries, GNU C Library, GNU Development Tools, Introduction Supporting Tools
-@subsection ANSI C Libraries
-
-This section discusses the following freely
-distributable ANSI C Libraries:
-
-@itemize @bullet
-@item GNU C Library, and
-
-@item NEWLIB
-@end itemize
-
-No C Library is included in the standard RTEMS
-distribution. It is the responsibility of the user to obtain
-and install a C Library separately.
-
-@node GNU C Library, NEWLIB C Library, ANSI C Libraries, Introduction Supporting Tools
-@subsection GNU C Library
-
-The GNU C Library is a robust and well-documented C
-Library which is distributed under the terms of the Library GNU
-Public License (LGPL). This library was not designed for use in
-real-time, embedded systems and the resource requirements of
-some of the routines in this library are an obvious indication
-of this. Additionally, this library does not have support for
-reentrancy in the sense that each task in a multitasking system
-could safely invoke every routine in the library. Finally, the
-distribution terms of the LGPL are considered undesirable by
-many embedded systems developers. However, the GNU C Library is
-very complete and is compliant with as many standards as
-possible. Because of this, it may be the only choice for many
-developers.
-
-@node NEWLIB C Library, Introduction Documentation, GNU C Library, Introduction Supporting Tools
-@subsection NEWLIB C Library
-
-The NEWLIB C Library was specifically designed for real-time embedded
-systems. It is a small, reasonably documented Library with support
-for reentrancy. This library is a collection of freely distributable
-and public domain source code and is freely distributable with as few
-restrictions as possible placed on the end user.
-
-@node Introduction Documentation, Installation Procedure, NEWLIB C Library, Introduction
-@section Documentation
-
-The RTEMS Documentation Set is provided online at
-@uref{http://www.rtems.org/onlinedocs.html}
-as reference information for all levels of RTEMS users.
-
-The RTEMS documentation set is available in HTML, PostScript, PDF, and DVI.
diff --git a/doc/relnotes/probrep.texi b/doc/relnotes/probrep.texi
deleted file mode 100644
index 31bf0cda1e..0000000000
--- a/doc/relnotes/probrep.texi
+++ /dev/null
@@ -1,57 +0,0 @@
-@c
-@c COPYRIGHT (c) 1989-2011.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
-
-
-
-@node RTEMS PROBLEM REPORT, Command and Variable Index, RTEMS Problem Reporting, Top
-@chapter RTEMS PROBLEM REPORT
-
-@example
-
-Customer (Company) Name:
-
-Customer Address:
-
-Contact Name:
-
-Telephone Voice: Fax:
-
-
-
-Product: Version:
-
-Target Processor: Target System:
-
-Host Computer System:
-
-Host Operating System: Version:
-
-
-
-Report Type: Customer Impact:
-
-
-
-[ ] Problem/Error [ ] System is inoperable, cannot proceed
-
-[ ] Enhancement [ ] Must be corrected in the near future
-
-[ ] Inquiry Suggestion [ ] Problem may be avoided until fixed
-
-[ ] Other______________ [ ] Problem is not time critical
-
- [ ] Minor problem
-
-@end example
-
-
-Please provide a detailed description of the
-problem (Attachments including source code, example code,
-makefiles, possible solutions, and any other information
-describing the problem will be appreciated):
-
-
-
-
diff --git a/doc/relnotes/relnotes.texi b/doc/relnotes/relnotes.texi
deleted file mode 100644
index de7ab76072..0000000000
--- a/doc/relnotes/relnotes.texi
+++ /dev/null
@@ -1,104 +0,0 @@
-\input texinfo @c -*-texinfo-*-
-@c %**start of header
-@setfilename relnotes.info
-@setcontentsaftertitlepage
-@syncodeindex vr fn
-@synindex ky cp
-@paragraphindent 0
-@c %**end of header
-
-@c
-@c COPYRIGHT (c) 1989-2013.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
-
-@c
-@c Master file
-@c
-
-@c Joel's Questions
-@c
-@c 1. Why does paragraphindent only impact makeinfo?
-@c 2. Why does paragraphindent show up in HTML?
-@c
-
-@include version.texi
-@include common/setup.texi
-@include common/rtems.texi
-
-@ifset use-ascii
-@dircategory RTEMS On-Line Manual
-@direntry
-* RTEMS Release Notes: (relnotes). Release Notes
-@end direntry
-@end ifset
-
-@c variable substitution info:
-@c
-@c @set LANGUAGE C
-@c the language is @value{LANGUAGE}
-@c NOTE: don't use underscore in the name
-@c
-
-@c
-@c Title Page Stuff
-@c
-
-@c
-@c I don't really like having a short title page. --joel
-@c
-@c @shorttitlepage RTEMS Release Notes
-
-@setchapternewpage odd
-@settitle RTEMS Release Notes
-@titlepage
-@finalout
-
-@title RTEMS Release Notes
-@subtitle Edition @value{EDITION}, for RTEMS @value{VERSION}
-@sp 1
-@subtitle @value{UPDATED}
-@author On-Line Applications Research Corporation
-@page
-@include common/cpright.texi
-@end titlepage
-
-@c This prevents a black box from being printed on "overflow" lines.
-@c The alternative is to rework a sentence to avoid this problem.
-
-@contents
-
-@ifnottex
-@node Top, Introduction, (dir), (dir)
-@top RTEMS Release Notes
-
-@menu
-* Introduction::
-* Installation Procedure::
-* Development Environment Status::
-* RTEMS PROBLEM REPORT::
-* Command and Variable Index::
-* Concept Index::
-@end menu
-@end ifnottex
-
-@include intro.texi
-@include install.texi
-@include status.texi
-@include probrep.texi
-
-@node Command and Variable Index, Concept Index, RTEMS PROBLEM REPORT, Top
-@unnumbered Command and Variable Index
-
-There are currently no Command and Variable Index entries.
-
-@c @printindex fn
-
-@node Concept Index, , Command and Variable Index, Top
-@unnumbered Concept Index
-
-There are currently no Concept Index entries.
-@c @printindex cp
-
-@bye
-
diff --git a/doc/relnotes/stamp-vti b/doc/relnotes/stamp-vti
deleted file mode 100644
index 5634951ec8..0000000000
--- a/doc/relnotes/stamp-vti
+++ /dev/null
@@ -1,4 +0,0 @@
-@set UPDATED 24 February 2013
-@set UPDATED-MONTH February 2013
-@set EDITION 4.10.99.0
-@set VERSION 4.10.99.0
diff --git a/doc/relnotes/status.texi b/doc/relnotes/status.texi
deleted file mode 100644
index 7b8c5b6bd3..0000000000
--- a/doc/relnotes/status.texi
+++ /dev/null
@@ -1,152 +0,0 @@
-@c
-@c COPYRIGHT (c) 1989-2014.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
-
-@node Development Environment Status, Development Environment Status RTEMS Executive Status, Installation Procedure Installing RTEMS, Top
-@chapter Development Environment Status
-@menu
-* Development Environment Status RTEMS Executive Status::
-* Development Environment Status Development Environment Status::
-* Development Environment Status Known Problems::
-@end menu
-
-This chapter will describe the current status of
-release version @value{VERSION} of the RTEMS Development Environment.
-
-@node Development Environment Status RTEMS Executive Status, Development Environment Status Development Environment Status, Development Environment Status, Development Environment Status
-@section RTEMS Executive Status
-
-Release @value{VERSION} of the RTEMS Executive contains support
-for both the classic RTEMS API based on the RTEID specification as well
-as support for POSIX threads and real-time extensions.
-
-The classic RTEMS API has the following managers based upon the RTEID
-specification:
-
-@itemize @bullet
-@item Task
-@item Initialization
-@item Clock
-@item Timer
-@item Interrupt
-@item Fatal Error
-@item Message
-@item Semaphore
-@item Event
-@item Signal
-@item Region
-@item Partition
-@item Dual Ported Memory
-@item I/O
-@item Multiprocessing
-@item Rate Monotonic
-@item User Extensions
-@end itemize
-
-RTEMS also has support for the following managers based upon the POSIX threads
-and real-time extensions:
-
-@itemize @bullet
-@item Thread
-@item Clock
-@item Key
-@item Condition Variable
-@item Mutex
-@item Signal
-@item Scheduler
-@end itemize
-
-This release of the C implementation supports the
-following processors and target boards:
-
-@itemize @bullet
-@item Motorola M68k family
-@itemize -
-@item DY-4 DMV152, SVME153
-@item Motorola IDP
-@item Motorola MVME135, MVME136
-@item Motorola MVME147, MVME147S
-@item Motorola MVME162
-@item EFI 68000 and 68332
-@item Generic 68302
-@item Generic 68360 and 68360 in companion mode with 68040
-@end itemize
-
-@item Intel i386 family
-@itemize -
-@item Force CPU386
-@item Intel i386ex eval board
-@item PC-AT i386 and above (go32)
-@end itemize
-
-@item PowerPC
-@itemize -
-@item Papyrus (proprietary controller)
-@end itemize
-
-@item SPARC
-@itemize -
-@item ERC32 (space-hardened V7)
-@end itemize
-
-@item MIPS
-@itemize -
-@item P4000 with R4600 or R4650
-@end itemize
-
-@end itemize
-
-Support for the NEWLIB Standard C Library is
-provided with this release which may be used on any of the RTEMS
-supported targets. The BSPs only provide support for console
-I/O only using this library. Support for the reentrancy
-capabilities of newlib is provided in the RTEMS distribution.
-
-@node Development Environment Status Development Environment Status, Development Environment Status Known Problems, Development Environment Status RTEMS Executive Status, Development Environment Status
-@section Development Environment Status
-
-This section details the versions of the tools used
-to develop and maintain RTEMS @value{VERSION}:
-
-@itemize @bullet
-@item Cross Tools
-@itemize -
-@item gcc - 2.7.2.2 with rtems patch
-@item binutils - 2.7 with rtems patch
-@item zip - 1.2.4
-@item make - 3.74
-@end itemize
-@end itemize
-
-
-@node Development Environment Status Known Problems, Executive Problems, Development Environment Status Development Environment Status, Development Environment Status
-@section Known Problems
-@menu
-* Executive Problems::
-* Development Environment Problems::
-* RTEMS Problem Reporting::
-@end menu
-
-Problems which are known to exist at the time of
-release are described in the following sections. These are
-provided as warnings to the user and where possible, workarounds
-are provided until the problem is corrected.
-
-@node Executive Problems, Development Environment Problems, Development Environment Status Known Problems, Development Environment Status Known Problems
-@subsection Executive Problems
-
-There are no known bugs in the executive itself.
-
-@node Development Environment Problems, RTEMS Problem Reporting, Executive Problems, Development Environment Status Known Problems
-@subsection Development Environment Problems
-
-There are no known major problems with the
-development environment.
-
-@node RTEMS Problem Reporting, RTEMS PROBLEM REPORT, Development Environment Problems, Development Environment Status Known Problems
-@subsection RTEMS Problem Reporting
-
-The RTEMS Project uses the Bugzilla Problem Reporting and Tracking System.
-Instructions for reporting a problem are located at
-@uref{http://rtems.org/wiki/index.php/RTEMSBugReporting}.
diff --git a/doc/relnotes/version.texi b/doc/relnotes/version.texi
deleted file mode 100644
index c0e4bbb7b6..0000000000
--- a/doc/relnotes/version.texi
+++ /dev/null
@@ -1,4 +0,0 @@
-@set UPDATED 17 July 2015
-@set UPDATED-MONTH July 2015
-@set EDITION 4.10.99.0
-@set VERSION 4.10.99.0