source: rtems/doc/develenv/direct.t @ 2bf21fc8

4.104.115
Last change on this file since 2bf21fc8 was da8e974a, checked in by Glenn Humphrey <glenn.humphrey@…>, on 11/29/07 at 16:02:42

2007-11-29 Glenn Humphrey <glenn.humphrey@…>

  • develenv/direct.t, develenv/sample.t: Corrected various errors.
  • Property mode set to 100644
File size: 24.9 KB
Line 
1@c
2@c  COPYRIGHT (c) 1989-2007.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Directory Structure
10
11The RTEMS directory structure is designed to meet
12the following requirements:
13
14@itemize @bullet
15@item encourage development of modular components.
16
17@item isolate processor and target dependent code, while
18allowing as much common source code as possible to be shared
19across multiple processors and target boards.
20
21@item allow multiple RTEMS users to perform simultaneous
22compilation of RTEMS and its support facilities for different
23processors and targets.
24@end itemize
25
26The resulting directory structure has processor and
27board dependent source files isolated from generic files.  When
28RTEMS is configured and built, object directories and
29an install point will be automatically created based upon
30the target CPU family and BSP selected. 
31
32The placement of object files based upon the selected BSP name
33ensures that object files are not mixed across CPUs or targets.
34This in combination with the makefiles allows the specific
35compilation options to be tailored for a particular target
36board.  For example, the efficiency of the memory subsystem for
37a particular target board may be sensitive to the alignment of
38data structures, while on another target board with the same
39processor memory may be very limited.  For the first target, the
40options could specify very strict alignment requirements, while
41on the second the data structures could be @i{packed} to conserve
42memory.  It is impossible to achieve this degree of flexibility
43without providing source code.
44
45The RTEMS source tree is organized based on the following variables:
46
47@itemize @bullet
48
49@item functionality,
50@item target processor family,
51@item target processor model,
52@item peripherals, and
53@item target board.
54
55@end itemize
56
57Each of the following sections will describe the
58contents of the directories in the RTEMS source
59tree.  The top of the tree will be referenced
60as @code{$@{RTEMS_ROOT@}} in this discussion.
61
62@c
63@c  Top Level Tree
64@c
65
66@c @ifset use-ascii
67@example
68@group
69                      rtems-VERSION
70                           |
71   +--------+----+----+----+--+-----+---+-------+--------+
72   |        |    |    |       |     |   |       |        |
73aclocal automake c contrib  cpukit doc make testsuites tools
74@end group
75@end example
76@c @end ifset
77
78@ifset use-tex
79@end ifset
80
81@ifset use-html
82@html
83@end html
84@end ifset
85
86@table @code
87@item $@{RTEMS_ROOT@}/aclocal/
88This directory contains the custom M4 macros which are available to
89the various GNU autoconf @code{configure.ac} scripts throughout
90the RTEMS source tree.  GNU autoconf interprets @code{configure.ac}
91files to produce the @code{configure} files used to tailor
92RTEMS build for a particular host and target environment.  The
93contents of this directory will not be discussed further in this
94document.
95
96@item $@{RTEMS_ROOT@}/automake/
97This directory contains the custom GNU automake fragments
98which are used to support the various @code{Makefile.am}
99files throughout the RTEMS source tree.  The
100contents of this directory will not be discussed
101further in this document.
102
103@item $@{RTEMS_ROOT@}/c/
104This directory is the root of the portions of the RTEMS source
105tree which must be built tailored for a particular CPU model
106or BSP.  The contents of this directory will be discussed
107in the @ref{Directory Structure c/ Directory} section.
108
109@item $@{RTEMS_ROOT@}/contrib/
110This directory contains contributed support software.  Currently
111this directory contains the RPM specifications for cross-compilers
112hosted on GNU/Linux that target various operating systems
113including MinGW, Cygwin, FreeBSD, and Solaris.  The
114cross-compilers produced using these specifications are then
115used in a Canadian cross build procedure to produce the various
116RTEMS toolsets on a GNU/Linux host. 
117
118This directory also contains RPM specifications for the
119prebuilt cross-compilation toolsets provided by the
120RTEMS project.  There are separate subdirectories
121for each of the components in the RTEMS Cross Compilation
122Environment unde the  @code{contrib/crossrpms/} directory.
123This directory is configured, built, and installed separately
124from the RTEMS executive and tests.  This directory will not
125be discussed further in this document.
126
127
128@item $@{RTEMS_ROOT@}/cpukit/
129This directory is the root for all of the "multilib'able"
130portions of RTEMS.  This is a GNU way of saying the
131contents of this directory can be compiled like the
132C Library (@code{libc.a}) and the functionality is
133neither CPU model nor BSP specific.  The source code
134for most RTEMS services reside under this directory.
135The contents of this directory will be discussed
136in the @ref{Directory Structure CPU Kit Directory} section.
137
138@item $@{RTEMS_ROOT@}/doc/
139This directory is the root for all RTEMS documentation.
140The source for RTEMS is written in GNU TeXinfo and
141used to produce HTML, PDF, and "info" files.
142The RTEMS documentation is configured, built,
143and installed separately from the RTEMS executive and tests.
144The contents of this directory will be discussed
145in the @ref{Directory Structure Documentation Directory} section.
146
147@item $@{RTEMS_ROOT@}/make/
148This directory contains files which support the
149RTEMS Makefile's.  From a user's perspective, the
150most important parts are found in the @code{custom/}
151subdirectory.  Each ".cfg" file in this directory
152is associated with a specific BSP and describes
153the CPU model, compiler flags, and procedure to
154produce an executable for the target board.
155These files are described in detail in the
156@b{RTEMS BSP and Device Driver Development Guide}
157and will not be discussed further in this document.
158
159@item $@{RTEMS_ROOT@}/testsuites/
160This directory contains the test suites for the
161various RTEMS APIs and support libraries.  The
162contents of this directory are discussed in the
163@ref{Directory Structure testsuites/ Test Suites} section.
164
165@item $@{RTEMS_ROOT@}/tools/
166This directory contains RTEMS specific support utilities which
167execute on the development host.  These utilities are divided
168into subdirectories based upon whether they are used in the process
169of building RTEMS and applications, are CPU specific, or are
170used to assist in updating the RTEMS source tree and applications.
171The support utilities used in the process of building RTEMS are
172described in @ref{RTEMS Specific Utilities}.  These are the
173only components of this subtree that will be discussed in this
174document.
175
176@end table
177
178
179
180@c
181@c  c/ Directions
182@c
183@section c/ Directory
184
185The @code{$@{RTEMS_ROOT@}/c/} directory was formerly
186the root directory of all RTEMS source code.  At this time, it contains
187the root directory for only those RTEMS components
188which must be compiled or linked in a way that is specific to a
189particular CPU model or board.  This directory contains the
190following subdirectories:
191
192@table @code
193@item $@{RTEMS_ROOT@}/c/src/
194This directory is logically the root for the RTEMS components
195which are CPU model or board dependent.  Thus this directory
196is the root for the BSPs and the Ada Test Suites as well
197as CPU model and BSP dependent libraries.  The contents of
198this directory are discussed in the
199@ref{Directory Structure c/src/ Directory} section.
200@end table
201
202@c
203@c c/src/ Directory
204@c
205@subsection c/src/ Directory
206
207As mentioned previously, this directory is logically
208the root for the RTEMS components
209which are CPU model or board dependent.  The
210following is a list of the subdirectories in this
211directory and a description of each.
212
213@table @code
214@item $@{RTEMS_ROOT@}/c/src/aclocal/
215This directory contains the custom M4 macros which are available to
216the various GNU autoconf @code{configure.ac} scripts throughout
217this portion of the RTEMS source tree.  GNU autoconf interprets
218@code{configure.ac} files to produce the @code{configure} files used
219to tailor RTEMS build for a particular host and target environment.  The
220contents of this directory will not be discussed further in this
221document.
222
223@item $@{RTEMS_ROOT@}/c/src/ada/
224This directory contains the Ada95 language bindings to the
225RTEMS Classic API.
226
227@item $@{RTEMS_ROOT@}/c/src/ada-tests/
228This directory contains the test suite for the Ada
229language bindings to the Classic API.
230
231@item $@{RTEMS_ROOT@}/c/src/automake/
232This directory contains files which are "Makefile fragments."
233They are included as required by the various @code{Makefile.am}
234files throughout this portion of the RTEMS source tree.
235
236@item $@{RTEMS_ROOT@}/c/src/lib/
237This directory contains the directories @code{libbsp/}
238and @code{libcpu/} which contain the source code for
239the Board Support Packages (BSPs) and CPU Model
240specific source code for RTEMS. 
241
242The @code{libbsp/} is organized based upon the CPU
243family and boards BSPs.  The contents of @code{libbsp/}
244are discussed briefly in
245@ref{Directory Structure c/src/lib/libbsp BSP Directory}
246and presented in detail in the
247@b{RTEMS BSP and Device Driver Development Guide}.
248
249The @code{libcpu/} directory is also organized by
250CPU family with further divisions based upon CPU
251model and features that are shared across CPU models
252such as caching and DMA.
253
254@item $@{RTEMS_ROOT@}/c/src/libchip/
255This directory contains device drivers for various
256peripheral chips which are designed to be CPU and
257board dependent.  This directory contains a variety
258of drivers for serial devices, network interface
259controllers, shared memory and real-time clocks.
260
261@item $@{RTEMS_ROOT@}/c/src/librtems++/
262This directory contains C++ classes which map to the RTEMS
263Classic API.
264
265@item $@{RTEMS_ROOT@}/c/src/make/
266This directory is used to generate the bulk of the supporting
267rules files which are installed as part of the Application Makefiles.
268This file contains settings for various Makefile variables to
269tailor them to the particular CPU model and BSP configured.
270
271@item $@{RTEMS_ROOT@}/c/src/nfsclient/
272This directory contains a Network File System (NFS) client
273for RTEMS.  With this file system, a user's application can
274access files on a remote computer.
275
276@item $@{RTEMS_ROOT@}/c/src/optman/
277This directory contains stubs for the RTEMS Classic API
278Managers which are considered optional and whose use
279may be explicitly forbidden by an application.  All of the
280directive implementations in this Optional Managers
281return @code{E_NOTCONFIGURED}.
282
283@item $@{RTEMS_ROOT@}/c/src/support/
284This directory exists solely to generate the RTEMS
285version string which includes the RTEMS version,
286CPU architecture, CPU model, and BSP name.
287
288@item $@{RTEMS_ROOT@}/c/src/wrapup/
289This directory is responsible for taking the individual
290libraries and objects built in each of the components
291in the RTEMS source tree and bundling them together to form
292the single RTEMS library @code{librtemsbsp.a}.  This
293library contains all BSP and CPU model specific software.
294
295@end table
296
297@c
298@c  c/src/lib/libbsp BSP Directory
299@c
300
301@subsubsection c/src/lib/libbsp BSP Directory
302
303The "libbsp" directory contains a directory for each CPU family supported
304by RTEMS.  Beneath each CPU directory is a directory for each BSP for that
305processor family.
306
307@c
308@c  Tree 7 - C BSP Library
309@c
310
311The "libbsp" directory provides all the BSPs provided with this
312release of the RTEMS executive.  The subdirectories are
313divided,  as discussed previously, based on specific processor
314family, then further broken down into specific target board
315environments.  The "no_cpu" subdirectory provides a starting point
316template BSP which can be used to develop a specific BSP for an
317unsupported target board.  The files in this subdirectory may aid
318in preliminary testing of the RTEMS development environment that has
319been built for no particular target in mind.
320
321Below each CPU dependent directory is a directory for each target BSP
322supported in this release.
323
324Each BSP provides the modules which comprise an RTEMS BSP.  The
325modules are separated into the subdirectories "clock", "console",
326"include", "shmsupp", "startup", and "timer" as shown in the following
327figure:
328
329@c
330@c  Tree 8 - Each BSP
331@c
332
333@c @ifset use-ascii
334@example
335@group
336                           Each BSP
337                               |
338  +-----------+----------+-----+-----+----------+----------+
339  |           |          |           |          |          |
340clock      console    include     shmsupp    startup     timer
341@end group
342@end example
343@c @end ifset
344
345@c
346@c  CPU Kit Directory
347@c
348@section CPU Kit Directory
349
350@c The @code{cpukit/} directory structure is as follows:
351
352@c
353@c  CPU Kit Tree
354@c
355
356@c @ifset use-ascii
357@c @example
358@c @group
359@c                        cpukit
360@c                          |
361@c   +-----------+----------+-----------+----------+
362@c   |           |          |           |          |
363@c posix       rtems       sapi       score     wrapup
364@c @end group
365@c @end example
366@c @end ifset
367
368The @code{cpukit/} directory contains a set of subdirectories which
369contains the source files comprising the executive portion of
370the RTEMS development environment as well as portable support
371libraries such as support for the C Library and filesystems.
372The API specific and "SuperCore" (e.g. @code{score/} directory)
373source code files are separated into distinct directory trees.
374
375The following is a description of each of the subdirectories
376under @code{cpukit/}:
377
378@table @code
379
380@item $@{RTEMS_ROOT@}/cpukit/aclocal/
381This directory contains the custom M4 macros which are available to
382the various GNU autoconf @code{configure.ac} scripts throughout
383the CPU Kit portion of the RTEMS source tree.
384GNU autoconf interprets @code{configure.ac}
385files to produce the @code{configure} files used to tailor
386RTEMS build for a particular host and target environment.  The
387contents of this directory will not be discussed further in this
388document.
389
390@item $@{RTEMS_ROOT@}/cpukit/automake/
391This directory contains files which are "Makefile fragments."
392They are included as required by the various @code{Makefile.am}
393files throughout the CPU Kit portion of the RTEMS source tree.
394
395@item $@{RTEMS_ROOT@}/cpukit/ftpd/
396This directory contains the RTEMS ftpd server.
397
398@item $@{RTEMS_ROOT@}/cpukit/httpd/
399This directory contains the port of the GoAhead
400web server to RTEMS.
401
402@item $@{RTEMS_ROOT@}/cpukit/include/
403This directory contains header files which are private to
404RTEMS and not considered to be owned by any other component
405in the CPU Kit.
406
407@item $@{RTEMS_ROOT@}/cpukit/itron/
408This directory contains the implementation of the
409ITRON API.
410
411@item $@{RTEMS_ROOT@}/cpukit/libblock/
412This directory contains support code for using
413Block Devices such as hard drives, floppies, and
414CD-ROMs.  It includes the generic IO primitives
415for block device drivers, disk caching support,
416and a RAM disk block device driver.
417
418@item $@{RTEMS_ROOT@}/cpukit/libcsupport/
419This directory contains the RTEMS specific support routines
420for the Newlib C Library.  This includes what are referred
421to as system calls and found in section 2 of the traditional
422UNIX manual.   In addition, it contains a thread-safe
423implementation of the Malloc family of routines as well
424as BSD and POSIX services not found in Newlib.
425
426@item $@{RTEMS_ROOT@}/cpukit/libfs/
427This directory contains the various non-networked
428filesystem implementations for RTEMS.  It includes
429the In-Memory FileSystem (IMFS), the mini-IMFS,
430and FAT filesystems.
431
432@item $@{RTEMS_ROOT@}/cpukit/libi2c/
433This directory contains the RTEMS I2C framework.
434
435@item $@{RTEMS_ROOT@}/cpukit/libmd/
436This directory contains a port of the standard MD5
437checksum code.
438
439@item $@{RTEMS_ROOT@}/c/src/libmisc/
440This directory contains support facilities which
441are RTEMS specific but otherwise unclassified.  In
442general, they do not adhere to a standard API. 
443Among the support facilities in this directory are
444a @code{/dev/null} device driver, the Stack
445Overflow Checker, a mini-shell, the CPU and
446rate monotonic period usage monitoring libraries,
447and a utility to "dump a buffer" in a nicely
448formatted way similar to many ROM monitors.
449
450@item $@{RTEMS_ROOT@}/cpukit/libnetworking/
451This directory contains the port of the FreeBSD
452TCP/IP stack to RTEMS.
453
454@item $@{RTEMS_ROOT@}/cpukit/librpc/
455This directory contains the port of the FreeBSD
456RPC/XDR source to RTEMS.
457
458@item $@{RTEMS_ROOT@}/cpukit/posix/
459This directory contains the RTEMS implementation
460of the threading portions of the POSIX API. 
461
462@item $@{RTEMS_ROOT@}/cpukit/pppd/
463This directory contains a port of the free implementation
464of the PPPD network protocol.
465
466@item $@{RTEMS_ROOT@}/cpukit/rtems/
467This directory contains the implementation of the
468Classic API.
469
470@item $@{RTEMS_ROOT@}/cpukit/sapi/
471This directory contains the implementation of RTEMS
472services which are required but beyond the realm
473of any standardization efforts.  It includes
474initialization, shutdown, and IO services.
475
476@item $@{RTEMS_ROOT@}/cpukit/score/
477This directory contains the "SuperCore" of RTEMS.
478All APIs are implemented in terms of SuperCore services.
479For example, Classic API tasks, POSIX threads, and ITRON
480tasks are all implemented in terms of SuperCore threads.
481This provides a common infrastructure and a high degree
482of interoperability between the APIs.  For example,
483services from all APIs may be used by any task/thread
484independent of the API used to create it.
485
486Within the @code{score/} directory the CPU dependent modules are found.
487The @code{score/cpu/} subdirectory contains a subdirectory for each
488target CPU supported by this release of the RTEMS
489executive.  Each processor directory contains the CPU dependent
490code necessary to host RTEMS.  The @code{no_cpu} directory provides a
491starting point for developing a new port to an unsupported
492processor.  The files contained within the @code{no_cpu} directory
493may also be used as a reference for the other ports to specific
494processors.
495
496@item $@{RTEMS_ROOT@}/cpukit/shttpd/
497This directory contains the port of the Simple HTTPD
498web server to RTEMS.
499
500@item $@{RTEMS_ROOT@}/cpukit/telnetd/
501This directory contains the RTEMS telnetd server.
502
503@item $@{RTEMS_ROOT@}/cpukit/wrapup/
504This directory is responsible for taking the individual
505libraries and objects built in each of the components
506in the RTEMS CPU Kit source tree and bundling them
507together to form the single RTEMS library @code{librtemscpu.a}.  This
508library contains all BSP and CPU model specific software.
509
510@item $@{RTEMS_ROOT@}/cpukit/zlib/
511This directory contains a port of the GNU Zlib compression
512library to RTEMS.
513
514@end table
515
516@c
517@c  testsuites/ Test Suites
518@c
519@section testsuites/ Test Suites
520
521This directory provides all of the RTEMS Test Suite
522except those for the Classic API Ada95 binding
523This includes the single processor tests, multiprocessor tests,
524timing tests, library tests, and sample tests.   Additionally,
525subdirectories for support functions and test related header
526files are provided.  The following table lists the test suites
527currently included with the RTEMS and the directory in which
528they may be located:
529
530@table @code
531
532@item $@{RTEMS_ROOT@}/testsuites/itrontests/
533This directory contains the test suite for the
534RTEMS ITRON API.
535
536@item $@{RTEMS_ROOT@}/testsuites/libtests/
537This directory contains the test suite for the
538various RTEMS support components.
539
540@item $@{RTEMS_ROOT@}/testsuites/mptests/
541This directory contains the test suite for the
542multiprocessor support in the Classic API.
543The tests provided address two node configurations
544and provide coverage for the multiprocessor code found
545in RTEMS.
546
547@item $@{RTEMS_ROOT@}/testsuites/psxtests/
548This directory contains the test suite for the
549RTEMS POSIX API.
550
551@item $@{RTEMS_ROOT@}/testsuites/samples/
552This directory provides sample application tests
553which aid in the testing a newly built RTEMS environment, a new
554BSP, or as starting points for the development of an application
555using the RTEMS executive.  They are discussed in
556@ref{Sample Applications}.
557
558@item $@{RTEMS_ROOT@}/testsuites/sptests/
559This directory contains the test suite for the RTEMS
560Classic API when executing on a single processor.
561The tests were originally designed to provide
562near complete test coverage for the entire
563executive code.  With the addition of multiple APIs,
564this is no longer the case as some SuperCore functionality
565is not available through the Classic API.  Thus
566some functionality in the SuperCore is only covered
567by tests in the POSIX API and ITRON API Test Suites.
568
569@item $@{RTEMS_ROOT@}/testsuites/support/
570This directory contains support software and header files
571for the various test suites.
572
573@item $@{RTEMS_ROOT@}/testsuites/tmitrontests/
574This directory contains the timing test suite for
575the RTEMS ITRON API.
576
577@item $@{RTEMS_ROOT@}/testsuites/tmtests/
578This directory contains the timing test suite for
579the RTEMS Classic API.  This include tests that
580benchmark each directive in the Classic API
581as well as a set of critical SuperCore functions.
582These tests are important for helping to verify
583that RTEMS performs as expected on your target hardware.
584It is not uncommon to discover mistakes in board
585initialization such as caching being disabled as
586a side-effect of analyzing the results of these tests.
587
588@item $@{RTEMS_ROOT@}/testsuites/tools/
589This directory contains tools which execute on
590the development host and aid in executing and
591evaluating the results of the test suite.  The
592tools @code{difftest} compares the output of one
593or more tests with the expected output.  If you
594place the output of all the @code{tmtests/} in
595a single file, then the utility @code{sorttimes}
596will be able to produce a report organizing the
597execution times by manager.
598
599@end table
600
601
602@c
603@c  Documentation Directory
604@c
605@section Documentation Directory
606
607This directory contains the source code for all RTEMS documentation
608in @code{TexInfo} format as well as utilities used in the generation
609of the RTEMS documentation set.  This source code is used to produce
610the RTEMS documentation in various formats including PDF, HTML,
611and PostScript.
612
613@table @code
614
615@item $@{RTEMS_ROOT@}/doc/ada_user/
616This directory contains the source code for the @cite{RTEMS
617Applications Ada User's Guide} which documents the Ada95
618binding to the Classic API.  This manual is produced from
619from the same source base as the @cite{RTEMS Application
620C User's Guide}.
621
622@item $@{RTEMS_ROOT@}/doc/bsp_howto/
623This directory contains the source code for the
624@cite{RTEMS BSP and Device Driver Development Guide}.
625
626@item $@{RTEMS_ROOT@}/doc/common/
627This directory contains the source code for the files which
628are shared across multiple manuals in the RTEMS Documentation Set.
629This includes the copyright page as well as the timing
630tables which can be filled in on a per BSP basis in the
631CPU supplements.
632
633@item $@{RTEMS_ROOT@}/doc/cpu_supplement/
634This directory contains the source code for the
635RTEMS CPU Supplement.
636
637@item $@{RTEMS_ROOT@}/doc/develenv/
638This directory contains the source code for the
639@cite{RTEMS Development Environment Guide}.  This is
640the document you are currently reading.
641
642@item $@{RTEMS_ROOT@}/doc/filesystem/
643This directory contains the source code for the
644@cite{RTEMS Filesystem Design Guide}.  This manual
645is a continuous work in process as it attempts to
646capture the design of the interface between system
647calls and filesystem implementations as well as the
648information required by those implementing filesystems.
649
650@item $@{RTEMS_ROOT@}/doc/images/
651This directory contains the source code for the graphics
652used in the HTML version of the RTEMS Documentation.
653
654@item $@{RTEMS_ROOT@}/doc/itron3.0/
655This directory contains the source code for the
656@cite{RTEMS ITRON 3.0 API User's Guide}.
657
658@item $@{RTEMS_ROOT@}/doc/networking/
659This directory contains the source code for the
660@cite{RTEMS Network Supplement}. 
661
662@item $@{RTEMS_ROOT@}/doc/new_chapters/
663This directory contains the source code for the new documentation
664components which have not yet been collected into a new manual or
665merged into an existing document.  Currently, this primarily
666contains draft documentation for some portions of
667the facilities implemented in @code{$@{RTEMS_ROOT@}/c/src/libmisc/}.
668
669@item $@{RTEMS_ROOT@}/doc/porting/
670This directory contains the source code for the
671@cite{RTEMS Porting Guide}.
672
673@item $@{RTEMS_ROOT@}/doc/posix1003.1/
674This directory contains the source code for the
675@cite{RTEMS POSIX 1003.1 Compliance Guide}.
676
677@item $@{RTEMS_ROOT@}/doc/posix_users/
678This directory contains the source code for the
679@cite{RTEMS POSIX API User's Guide}.  It is important to
680note that RTEMS' support for POSIX is a combination of
681functionality provided by RTEMS and the Newlib C Library
682so some functionality is documented by Newlib.
683
684@item $@{RTEMS_ROOT@}/doc/relnotes/
685This directory contains the source code for a formally
686release notes document.  This has not been used for
687recent RTEMS releases.
688
689@item $@{RTEMS_ROOT@}/doc/started/
690This directory contains the source code for the
691@cite{Getting Started with RTEMS for C/C++ Users} manual.
692
693@item $@{RTEMS_ROOT@}/doc/started_ada/
694This directory contains the source code for the
695@cite{Getting Started with RTEMS for Ada Users} manual.
696
697@item $@{RTEMS_ROOT@}/doc/tools/
698This directory contains the source code for the tools
699used on the development host to assist in producing the
700RTEMS Documentation.  The most important of these tools
701is @code{bmenu} which generates the hierarchical node
702linking commands based upon chapter, section, and
703subsection organization.
704
705@item $@{RTEMS_ROOT@}/doc/user/
706This directory contains the source code for the @cite{RTEMS
707Applications C User's Guide} which documents the Classic API.
708
709@end table
Note: See TracBrowser for help on using the repository browser.