source: rtems/doc/develenv/direct.t @ 2723df7

Last change on this file since 2723df7 was 2723df7, checked in by Joel Sherrill <joel.sherrill@…>, on Nov 27, 2007 at 7:31:13 PM

2007-11-27 Joel Sherrill <joel.sherrill@…>

  • develenv/develenv.texi, develenv/direct.t, develenv/intro.texi, develenv/sample.t, develenv/utils.t: Update directory tree.
  • Property mode set to 100644
File size: 24.8 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 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
154a produce 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.  This
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
201@item $@{RTEMS_ROOT@}/c/make/
202This directory is used to generate the file @code{target.cfg}
203which is installed as part of the Application Makefiles.  This
204file contains settings for various Makefile variables to
205tailor them to the particular CPU model and BSP configured.
206
207@end table
208
209@c
210@c c/src/ Directory
211@c
212@subsection c/src/ Directory
213
214As mentioned previously, this directory is logically
215the root for the RTEMS components
216which are CPU model or board dependent.  The
217following is a list of the subdirectories in this
218directorie and a description of each.
219
220@table @code
221@item $@{RTEMS_ROOT@}/c/src/ada/
222This directory contains the Ada95 language bindings to the
223RTEMS Classic API.
224
225@item $@{RTEMS_ROOT@}/c/src/ada-tests/
226This directory contains the test suite for the Ada
227language bindings to the Classic API.
228
229@item $@{RTEMS_ROOT@}/c/src/lib/
230This directory contains the directories @code{libbsp}
231and @code{libcpu/} which contain the source code for
232the Board Support Packages (BSPs) and CPU Model
233specific source code for RTEMS. 
234
235The @code{libbsp/} is organized based upon the CPU
236family and boards BSPs.  The contents of @code{libbsp/}
237are discussed briefly in
238@ref{Directory Structure c/src/lib/libbsp BSP Directory}
239and presented in detail in the
240@b{RTEMS BSP and Device Driver Development Guide}.
241
242The @code{libcpu/} directory is also organized by
243CPU family with further divisions based upon CPU
244model and features that are shared across CPU models
245such as caching and DMA.
246
247@item $@{RTEMS_ROOT@}/c/src/libchip/
248This directory contains device drivers for various
249peripheral chips which are designed to be CPU and
250board dependent.  This directory contains a variety
251of drivers for serial devices, network interface
252controllers, and real-time clocks.
253
254@item $@{RTEMS_ROOT@}/c/src/librdbg/
255This directory contains the Ethernet-based remote debugging
256stub.  This software must be built to be intimately aware
257of a particular CPU model.
258
259@item $@{RTEMS_ROOT@}/c/src/librtems++/
260This directory contains C++ classes which map to the RTEMS
261Classic API.
262
263@item $@{RTEMS_ROOT@}/c/src/make/
264This directory is used to generate the bulk of the supporting
265rules files which are installed as part of the Application Makefiles.
266This file contains settings for various Makefile variables to
267tailor them to the particular CPU model and BSP configured.
268
269@item $@{RTEMS_ROOT@}/c/src/optman/
270This directory contains stubs for the RTEMS Classic API
271Managers which are considered optional and whose use
272may be explicitly forbidden by an application.  All of the
273directive implementations in this Optional Managers
274return @code{E_NOTCONFIGURED}.
275
276@item $@{RTEMS_ROOT@}/c/src/wrapup/
277This directory is responsible for taking the individual
278libraries and objects built in each of the components
279in the RTEMS source tree and bundling them together to form
280the single RTEMS library @code{librtemsbsp.a}.  This
281library contains all BSP and CPU model specific software.
282
283@end table
284
285@c
286@c  c/src/lib/libbsp BSP Directory
287@c
288
289@subsubsection c/src/lib/libbsp BSP Directory
290
291The "libbsp" directory contains a directory for each CPU family supported
292by RTEMS.  Beneath each CPU directory is a directory for each BSP for that
293processor family.
294
295@c
296@c  Tree 7 - C BSP Library
297@c
298
299The "libbsp" directory provides all the BSPs provided with this
300release of the RTEMS executive.  The subdirectories are
301divided,  as discussed previously, based on specific processor
302family, then further breaking down into specific target board
303environments.  The "shmdr" subdirectory provides the
304implementation of a shared memory driver which supports the
305multiprocessing portion of the executive.  In addition, two
306starting point subdirectories are provided for reference.  The
307"no_cpu" subdirectory provides a template BSP which can be used
308to develop a specific BSP for an unsupported target board.  The
309"stubdr" subdirectory provides stubbed out BSPs.  These files
310may aid in preliminary testing of the RTEMS development
311environment that has been built for no particular target in mind.
312
313Below each CPU dependent directory is a directory for each target BSP
314supported in this release.
315
316Each BSP provides the modules which comprise an RTEMS BSP.  The
317modules are separated into the subdirectories "clock", "console",
318"include", "shmsupp", "startup", and "timer" as shown in the following
319figure:
320
321@c
322@c  Tree 8 - Each BSP
323@c
324
325@c @ifset use-ascii
326@example
327@group
328                           Each BSP
329                               |
330  +-----------+----------+-----+-----+----------+----------+
331  |           |          |           |          |          |
332clock      console    include     shmsupp    startup     timer
333@end group
334@end example
335@c @end ifset
336
337@c
338@c  CPU Kit Directory
339@c
340@section CPU Kit Directory
341
342@c The @code{cpukit/} directory structure is as follows:
343
344@c
345@c  CPU Kit Tree
346@c
347
348@c @ifset use-ascii
349@c @example
350@c @group
351@c                        cpukit
352@c                          |
353@c   +-----------+----------+-----------+----------+
354@c   |           |          |           |          |
355@c posix       rtems       sapi       score     wrapup
356@c @end group
357@c @end example
358@c @end ifset
359
360The @code{cpukit/} directory contains a set of subdirectories which
361contains the source files comprising the executive portion of
362the RTEMS development environment as well as portable support
363libraries such as support for the C Library and filesystems.
364The API specific and "SuperCore" (e.g. @code{score/} directory)
365source code files are separated into distinct directory trees.
366
367The following is a description of each of the subdirectories
368under @code{cpukit/}:
369
370@table @code
371
372@item $@{RTEMS_ROOT@}/cpukit/aclocal/
373This directory contains the custom M4 macros which are available to
374the various GNU autoconf @code{configure.ac} scripts throughout
375the CPU Kit portion of the RTEMS source tree.
376GNU autoconf interprets @code{configure.ac}
377files to produce the @code{configure} files used to tailor
378RTEMS build for a particular host and target environment.  The
379contents of this directory will not be discussed further in this
380document.
381
382@item $@{RTEMS_ROOT@}/cpukit/automake/
383This directory contains files which are "Makefile fragments."
384They are included as required by the various @code{Makefile.am}
385files throughout the CPU Kit portion of the RTEMS source tree.
386
387@item $@{RTEMS_ROOT@}/cpukit/ftpd/
388This directory contains the RTEMS ftpd server.
389
390@item $@{RTEMS_ROOT@}/cpukit/httpd/
391This directory contains the port of the GoAhead
392web server to RTEMS.
393
394@item $@{RTEMS_ROOT@}/cpukit/include/
395This directory contains header files which are private to
396RTEMS and not considered to be owned by any other component
397in the CPU Kit.
398
399@item $@{RTEMS_ROOT@}/cpukit/itron/
400This directory contains the implementation of the
401ITRON API.
402
403@item $@{RTEMS_ROOT@}/cpukit/libblock/
404This directory contains support code for using
405Block Devices such as hard drives, floppies, and
406CD-ROMs.  It includes the generic IO primitives
407for block device drivers, disk caching support,
408and a RAM disk block device driver.
409
410@item $@{RTEMS_ROOT@}/cpukit/libcsupport/
411This directory contains the RTEMS specific support routines
412for the Newlib C Library.  This includes what are referred
413to as system calls and found in section 2 of the traditional
414UNIX manual.   In addition, it contains a thread-safe
415implementation of the Malloc family of routines as well
416as BSD and POSIX services not found in Newlib.
417
418@item $@{RTEMS_ROOT@}/cpukit/libfs/
419This directory contains the various non-networked
420filesystem implementations for RTEMS.  It includes
421the In-Memory FileSystem (IMFS), the mini-IMFS,
422and FAT filesystems.
423
424@item $@{RTEMS_ROOT@}/cpukit/libi2c/
425This directory contains the RTEMS I2C framework.
426
427@item $@{RTEMS_ROOT@}/cpukit/libmd/
428This directory contains a port of the standard MD5
429checksum code.
430
431@item $@{RTEMS_ROOT@}/c/src/libmisc/
432This directory contains support facilities which
433are RTEMS specific but otherwise unclassified.  In
434general, they do not adhere to a standard API. 
435Among the support facilities in this directory are
436a @code{/dev/null} device driver, the Stack
437Overflow Checker, a mini-shell, the CPU and
438rate monotonic period usage monitoring libraries,
439and a utility to "dump a buffer" in a nicely
440formatted way similar to many ROM monitors.
441
442@item $@{RTEMS_ROOT@}/cpukit/libnetworking/
443This directory contains the port of the FreeBSD
444TCP/IP stack to RTEMS.
445
446@item $@{RTEMS_ROOT@}/cpukit/librpc/
447This directory contains the port of the FreeBSD
448RPC/XDR source to RTEMS.
449
450@item $@{RTEMS_ROOT@}/cpukit/posix/
451This directory contains the RTEMS implementation
452of the threading portions of the POSIX API. 
453
454@item $@{RTEMS_ROOT@}/cpukit/pppd/
455This directory contains a port of the free implementation
456of the PPPD network protocol.
457
458@item $@{RTEMS_ROOT@}/cpukit/rtems/
459This directory contains the implementation of the
460Classic API.
461
462@item $@{RTEMS_ROOT@}/cpukit/sapi/
463This directory contains the implementation of RTEMS
464services which are required but beyond the realm
465of any standardization efforts.  It includes
466initialization, shutdown, and IO services.
467
468@item $@{RTEMS_ROOT@}/cpukit/score/
469This directory contains the "SuperCore" of RTEMS.
470All APIs are implemented in terms of SuperCore services.
471For example, Classic API tasks, POSIX threads, and ITRON
472tasks are all implemented in terms of SuperCore threads.
473This provides a common infrastructure and a high degree
474of interoperability between the APIs.  For example,
475services from all APIs may be used by any task/thread
476independent of the API used to create it.
477
478Within the @code{score/} directory the CPU dependent modules are found.
479The @code{score/cpu/} subdirectory contains a subdirectory for each
480target CPU supported by this release of the RTEMS
481executive.  Each processor directory contains the CPU dependent
482code necessary to host RTEMS.  The @code{no_cpu} directory provides a
483starting point for developing a new port to an unsupported
484processor.  The files contained within the @code{no_cpu} directory
485may also be used as a reference for the other ports to specific
486processors.
487
488@item $@{RTEMS_ROOT@}/cpukit/shttpd/
489This directory contains the port of the Simple HTTPD
490web server to RTEMS.
491
492@item $@{RTEMS_ROOT@}/cpukit/telnet/
493This directory contains the RTEMS telnetd server.
494
495@item $@{RTEMS_ROOT@}/cpukit/wrapup/
496This directory is responsible for taking the individual
497libraries and objects built in each of the components
498in the RTEMS CPU Kit source tree and bundling them
499together to form the single RTEMS library @code{librtemscpu.a}.  This
500library contains all BSP and CPU model specific software.
501
502@item $@{RTEMS_ROOT@}/cpukit/zlib/
503This directory contains a port of the GNU Zlib compression
504library to RTEMS.
505
506@end table
507
508@c
509@c  testsuites/ Test Suites
510@c
511@section testsuites/ Test Suites
512
513This directory provides all of the RTEMS Test Suite
514except those for the Classic API Ada95 binding
515This includes the single processor tests, multiprocessor tests,
516timing tests, library tests, and sample tests.   Additionally,
517subdirectories for support functions and test related header
518files are provided.  The following table lists the test suites
519currently included with the RTEMS and the directory in which
520they may be located:
521
522@table @code
523
524@item $@{RTEMS_ROOT@}/testsuites/itrontests/
525This directory contains the test suite for the
526RTEMS ITRON API.
527
528@item $@{RTEMS_ROOT@}/testsuites/libtests/
529This directory contains the test suite for the
530various RTEMS support components.
531
532@item $@{RTEMS_ROOT@}/testsuites/mptests/
533This directory contains the test suite for the
534multiprocessor support in the Classic API.
535The tests provided address two node configurations
536and provide coverage for the multiprocessor code found
537in RTEMS.
538
539@item $@{RTEMS_ROOT@}/testsuites/psxtests/
540This directory contains the test suite for the
541RTEMS POSIX API.
542
543@item $@{RTEMS_ROOT@}/testsuites/samples/
544This directory provides sample application tests
545which aid in the testing a newly built RTEMS environment, a new
546BSP, or as starting points for the development of an application
547using the RTEMS executive.  They are discussed in
548@ref{Sample Applications}.
549
550@item $@{RTEMS_ROOT@}/testsuites/sptests/
551This directory contains the test suite for the RTEMS
552Classic API when executing on a single processor.
553The tests were originally designed to provide
554near complete test coverage for the the entire
555executive code.  With the addition of multiple APIs,
556this is no longer the case as some SuperCore functionality
557is not available through the Classic API.  Thus
558some functionality in the SuperCore is only covered
559by tests in the POSIX API and ITRON API Test Suites.
560
561@item $@{RTEMS_ROOT@}/testsuites/support/
562This directory contains support software and header files
563for the various test suites.
564
565@item $@{RTEMS_ROOT@}/testsuites/tmitrontests/
566This directory contains the timing test suite for
567the RTEMS ITRON API.
568
569@item $@{RTEMS_ROOT@}/testsuites/tmtests/
570This directory contains the timing test suite for
571the RTEMS Classic API.  This include tests that
572benchmark each directive in the Classic API
573as well as a set of critical SuperCore functions.
574These tests are important for helping to verify
575that RTEMS performs as expected on your target hardware.
576It is not uncommon to discover mistakes in board
577initialization such as caching being disabled as
578a side-effect of analyzing the results of these tests.
579
580@item $@{RTEMS_ROOT@}/testsuites/tools/
581This directory contains tools which execute on
582the development host and aid in executing and
583evaluating the results of the test suite.  The
584tools @code{difftest} compares the output of one
585or more tests with the expected output.  If you
586place the output of all the @code{tmtests/} in
587a single file, then the utility @code{sorttimes}
588will be able to produce a report organizing the
589execution times by manager.
590
591@end table
592
593
594@c
595@c  Documentation Directory
596@c
597@section Documentation Directory
598
599This directory contains the source code for all RTEMS documentation
600in @code{TexInfo} format as well as utilities used in the generation
601of the RTEMS documentation set.  This source code is used to produce
602the RTEMS documentation in various formats including PDF, HTML,
603and PostScript.
604
605@table @code
606
607@item $@{RTEMS_ROOT@}/doc/user/
608This directory contains the source code for the @cite{RTEMS
609Applications C User's Guide} which documents the Classic API.
610
611@item $@{RTEMS_ROOT@}/doc/ada_user/
612This directory contains the source code for the @cite{RTEMS
613Applications Ada User's Guide} which documents the Ada95
614binding to the Classic API.  This manual is produced from
615from the same source base as the @cite{RTEMS Application
616C User's Guide}.
617
618@item $@{RTEMS_ROOT@}/doc/bsp_howto/
619This directory contains the source code for the
620@cite{RTEMS BSP and Device Driver Development Guide}.
621
622@item $@{RTEMS_ROOT@}/doc/common/
623This directory contains the source code for the files which
624are shared across multiple manuals in the RTEMS Documentation Set.
625This includes the copyright page as well as the timing
626tables which can be filled in on a per BSP basis in the
627CPU supplements.
628
629@item $@{RTEMS_ROOT@}/doc/cpu_supplement/
630This directory contains the source code for the
631RTEMS CPU Supplement.
632
633@item $@{RTEMS_ROOT@}/doc/develenv/
634This directory contains the source code for the
635@cite{RTEMS Development Environment Guide}.  This is
636the document you are currently reading.
637
638@item $@{RTEMS_ROOT@}/doc/filesystem/
639This directory contains the source code for the
640@cite{RTEMS Filesystem Design Guide}.  This manual
641is a continuous work in process as it attempts to
642capture the design of the interface between system
643calls and filesystem implementations as well as the
644information required by those implementing filesystems.
645
646@item $@{RTEMS_ROOT@}/doc/images/
647This directory contains the source code for the graphics
648used in the HTML version of the RTEMS Documentation.
649
650@item $@{RTEMS_ROOT@}/doc/itron3.0/
651This directory contains the source code for the
652@cite{RTEMS ITRON 3.0 API User's Guide}.
653
654@item $@{RTEMS_ROOT@}/doc/networking/
655This directory contains the source code for the
656@cite{RTEMS Network Supplement}. 
657
658@item $@{RTEMS_ROOT@}/doc/new_chapters/
659This directory contains the source code for the new documentation
660components which have not yet been collected into a new manual or
661merged into an existing document.  Currently, this primarily
662contains draft documentation for some portions of
663the facilities implemented in @code{$@{RTEMS_ROOT@}/c/src/libmisc/}.
664
665@item $@{RTEMS_ROOT@}/doc/porting/
666This directory contains the source code for the
667@cite{RTEMS Porting Guide}.
668
669@item $@{RTEMS_ROOT@}/doc/posix1003.1/
670This directory contains the source code for the
671@cite{RTEMS POSIX 1003.1 Compliance Guide}.
672
673@item $@{RTEMS_ROOT@}/doc/posix_users/
674This directory contains the source code for the
675@cite{RTEMS POSIX API User's Guide}.  It is important to
676note that RTEMS' support for POSIX is a combination of
677functionality provided by RTEMS and the Newlib C Library
678so some functionality is documented by Newlib.
679
680@item $@{RTEMS_ROOT@}/doc/relnotes/
681This directory contains the source code for a formally
682release notes document.  This has not been used for
683recent RTEMS releases.
684
685@item $@{RTEMS_ROOT@}/doc/rgdb_specs/
686This directory contains the source code for the
687@cite{RTEMS Remote Debugger Server Specifications}.
688
689@item $@{RTEMS_ROOT@}/doc/rtems_gdb/
690This directory contains the source code for the
691@cite{RTEMS/GDB User's Guide}.
692
693@item $@{RTEMS_ROOT@}/doc/started/
694This directory contains the source code for the
695@cite{Getting Started with RTEMS for C/C++ Users} manual.
696
697@item $@{RTEMS_ROOT@}/doc/started_ada/
698This directory contains the source code for the
699@cite{Getting Started with RTEMS for Ada Users} manual.
700
701@item $@{RTEMS_ROOT@}/doc/tools/
702This directory contains the source code for the tools
703used on the development host to assist in producing the
704RTEMS Documentation.  The most important of these tools
705is @code{bmenu} which generates the hierarchical node
706linking commands based upon chapter, section, and
707subsection organization.
708
709@end table
Note: See TracBrowser for help on using the repository browser.