forked from Imagelibrary/rtems
2ba8875a0b
which contains the bulk of converting the documentation tree to automake and GNU conventions. Comments follow: This is the automake port of rtemsdoc. To apply: cvs co rtemsdoc cd rtemsdoc sh cvs-rm.sh patch -p0 < rtemsdoc-4.5.0-rc-0.diff sh cvs-add.sh [Attention: cvs-rm.sh and cvs-add.sh directly modify cvs] Known bugs: 1) src2html is not supported (yet? - Is this supposed to work?) 2) all *.pdf images now are generated on-the-fly, but not yet deleted during "make distclean" 3) All supplements, including the templated ones, get build and installed. 4) Building outside of the source tree is completely untested and very likely does not work. 5) Make [ps|pdf] are not (yet) supported, make [dvi|info] are supported by automake's default texinfo rules. Fixing 2, 3 and 5 is almost trivial and needs to be done. 4) is a matter of testing and tool-properties, for now it is simply untested. General issues: * gif vs jpg vs png. I would recommend to replace all images with pngs to avoid potential copyright issues (gif) or lack in quality (jpg, jpg is good for real world photographs, but extremely poor on artificial images, graphs). * pdf images do net get placed correctly in pdf-documents. * texinfo: We now use a local copy of texinfo-4.0's texinfo.tex in texinfo/texinfo.tex for generating infos. However pdftex's system-wide texinfo.tex and pdftexinfo.tex are used for generating *.dvi, *.ps, *.pdf. * .cvsignore files still missing. * I have renamed the supplements filename not to use c_<supplement>, because automake seems to have problems with it. Notes: * Again, I recommend not to put any generated files into CVS. Here, this comprises some *texi, all *.pdf and many *.html pages. Ie. I recommend to run make maintainer-clean before checking in any files. * To get building started, this should be sufficient: ./bootstrap ./configure cd tools; make; cd .. make info * To make a public tarball: [cvs co ; ./bootstrap] ./configure cd tools; make; cd .. make info [make clean] make dist => This generates a rtems-<version>.tar.gz in the toplevel directory. => Building the tools only is required after a "cvs co", but not in a distribution tarball.
120 lines
2.4 KiB
Plaintext
120 lines
2.4 KiB
Plaintext
\input texinfo @c -*-texinfo-*-
|
|
@c %**start of header
|
|
@setfilename started
|
|
@syncodeindex vr fn
|
|
@synindex ky cp
|
|
@paragraphindent 0
|
|
@c @smallbook
|
|
@c %**end of header
|
|
|
|
@c
|
|
@c COPYRIGHT (c) 1988-1999.
|
|
@c On-Line Applications Research Corporation (OAR).
|
|
@c All rights reserved.
|
|
@c
|
|
@c $Id$
|
|
@c
|
|
|
|
@c
|
|
@c Master file for the Getting Started (C) Guide
|
|
@c
|
|
|
|
@include ../common/setup.texi
|
|
|
|
@c
|
|
@c Now set all the tool version dependent information
|
|
@c
|
|
@include tversions.texi
|
|
|
|
@ignore
|
|
@ifinfo
|
|
@format
|
|
START-INFO-DIR-ENTRY
|
|
* Getting Started with RTEMS for C/C++ Users (started):
|
|
END-INFO-DIR-ENTRY
|
|
@end format
|
|
@end ifinfo
|
|
@end ignore
|
|
|
|
@c
|
|
@c Title Page Stuff
|
|
@c
|
|
|
|
@set edition @value{RTEMS-EDITION}
|
|
@set version @value{RTEMS-VERSION}
|
|
@set update-date @value{RTEMS-UPDATE-DATE}
|
|
@set update-month @value{RTEMS-UPDATE-MONTH}
|
|
|
|
@c
|
|
@c I don't really like having a short title page. --joel
|
|
@c
|
|
@c @shorttitlepage Getting Started with RTEMS
|
|
|
|
@setchapternewpage odd
|
|
@settitle Getting Started with RTEMS for C/C++ Users
|
|
@titlepage
|
|
@finalout
|
|
|
|
@title Getting Started with RTEMS for C/C++ Users
|
|
@subtitle Edition @value{edition}, for @value{version}
|
|
@sp 1
|
|
@subtitle @value{update-month}
|
|
@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.
|
|
|
|
@include intro.texi
|
|
@include require.texi
|
|
@include binaries.texi
|
|
@include buildc.texi
|
|
@include buildrt.texi
|
|
@include sample.texi
|
|
@include gdb.texi
|
|
@include nt.texi
|
|
|
|
@ifinfo
|
|
@node Top, Introduction, (dir), (dir)
|
|
@top started
|
|
|
|
This is the online version of the Getting Started with RTEMS for C/C++ Users.
|
|
|
|
@menu
|
|
* Introduction::
|
|
* Requirements::
|
|
* Prebuilt Toolset Executables::
|
|
* Building the GNU C/C++ Cross Compiler Toolset::
|
|
* Building RTEMS::
|
|
* Building the Sample Application::
|
|
* Building the GNU Debugger::
|
|
* Using MS-Windows as a Development Host::
|
|
@end menu
|
|
|
|
@c * Command and Variable Index::
|
|
@c * Concept Index::
|
|
@end ifinfo
|
|
@c
|
|
@c
|
|
@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
|
|
@c
|
|
|
|
@c @node Command and Variable Index, Concept Index, Installing EGCS AND NEWLIB, Top
|
|
@c @unnumbered Command and Variable Index
|
|
|
|
@c There are currently no Command and Variable Index entries.
|
|
|
|
@c @printindex fn
|
|
|
|
@c @node Concept Index, , Command and Variable Index, Top
|
|
@c @unnumbered Concept Index
|
|
|
|
@c There are currently no Concept Index entries.
|
|
@c @printindex cp
|
|
|
|
@contents
|
|
@bye
|
|
|