Changeset 1e121d83 in rtems


Ignore:
Timestamp:
Nov 29, 2007, 4:13:53 PM (13 years ago)
Author:
Glenn Humphrey <glenn.humphrey@…>
Children:
b4bf1970
Parents:
1773d3b
Message:

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

  • develenv/direct.t, develenv/sample.t: Corrected various errors in the documentation.
Location:
doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r1773d3b r1e121d83  
     12007-11-29      Glenn Humphrey <glenn.humphrey@OARcorp.com>
     2
     3        * develenv/direct.t, develenv/sample.t: Corrected various errors in the
     4        documentation.
     5
    162007-11-28      Glenn Humphrey <glenn.humphrey@OARcorp.com>
    27
  • doc/develenv/direct.t

    r1773d3b r1e121d83  
    125125be discussed further in this document.
    126126
    127 
    128127@item $@{RTEMS_ROOT@}/cpukit/
    129128This directory is the root for all of the "multilib'able"
    130 portions of RTEMS.  This is a GNU way of saying the the
     129portions of RTEMS.  This is a GNU way of saying the
    131130contents of this directory can be compiled like the
    132131C Library (@code{libc.a}) and the functionality is
     
    152151is associated with a specific BSP and describes
    153152the CPU model, compiler flags, and procedure to
    154 a produce an executable for the target board.
     153produce an executable for the target board.
    155154These files are described in detail in the
    156155@b{RTEMS BSP and Device Driver Development Guide}
     
    159158@item $@{RTEMS_ROOT@}/testsuites/
    160159This directory contains the test suites for the
    161 various RTEMS APIs and support libraries.  This
     160various RTEMS APIs and support libraries.  The
    162161contents of this directory are discussed in the
    163162@ref{Directory Structure testsuites/ Test Suites} section.
     
    176175@end table
    177176
    178 
    179 
    180177@c
    181178@c  c/ Directions
     
    198195this directory are discussed in the
    199196@ref{Directory Structure c/src/ Directory} section.
    200 
    201 @item $@{RTEMS_ROOT@}/c/make/
    202 This directory is used to generate the file @code{target.cfg}
    203 which is installed as part of the Application Makefiles.  This
    204 file contains settings for various Makefile variables to
    205 tailor them to the particular CPU model and BSP configured.
    206 
    207197@end table
    208198
     
    216206which are CPU model or board dependent.  The
    217207following is a list of the subdirectories in this
    218 directorie and a description of each.
     208directory and a description of each.
    219209
    220210@table @code
     211@item $@{RTEMS_ROOT@}/c/src/aclocal/
     212This directory contains the custom M4 macros which are available to
     213the various GNU autoconf @code{configure.ac} scripts throughout
     214this portion of the RTEMS source tree.  GNU autoconf interprets
     215@code{configure.ac} files to produce the @code{configure} files used
     216to tailor RTEMS build for a particular host and target environment.  The
     217contents of this directory will not be discussed further in this
     218document.
     219
    221220@item $@{RTEMS_ROOT@}/c/src/ada/
    222221This directory contains the Ada95 language bindings to the
     
    227226language bindings to the Classic API.
    228227
     228@item $@{RTEMS_ROOT@}/c/src/automake/
     229This directory contains files which are "Makefile fragments."
     230They are included as required by the various @code{Makefile.am}
     231files throughout this portion of the RTEMS source tree.
     232
    229233@item $@{RTEMS_ROOT@}/c/src/lib/
    230 This directory contains the directories @code{libbsp}
     234This directory contains the directories @code{libbsp/}
    231235and @code{libcpu/} which contain the source code for
    232236the Board Support Packages (BSPs) and CPU Model
     
    250254board dependent.  This directory contains a variety
    251255of drivers for serial devices, network interface
    252 controllers, and real-time clocks.
     256controllers, shared memory and real-time clocks.
    253257
    254258@item $@{RTEMS_ROOT@}/c/src/librdbg/
     
    274278return @code{E_NOTCONFIGURED}.
    275279
     280@item $@{RTEMS_ROOT@}/c/src/support/
     281This directory exists solely to generate the RTEMS
     282version string which includes the RTEMS version,
     283CPU architecture, CPU model, and BSP name.
     284
    276285@item $@{RTEMS_ROOT@}/c/src/wrapup/
    277286This directory is responsible for taking the individual
     
    286295@c  c/src/lib/libbsp BSP Directory
    287296@c
    288 
    289297@subsubsection c/src/lib/libbsp BSP Directory
    290298
     
    296304@c  Tree 7 - C BSP Library
    297305@c
    298 
    299306The "libbsp" directory provides all the BSPs provided with this
    300307release of the RTEMS executive.  The subdirectories are
    301308divided,  as discussed previously, based on specific processor
    302 family, then further breaking down into specific target board
    303 environments.  The "shmdr" subdirectory provides the
    304 implementation of a shared memory driver which supports the
    305 multiprocessing portion of the executive.  In addition, two
    306 starting point subdirectories are provided for reference.  The
    307 "no_cpu" subdirectory provides a template BSP which can be used
    308 to develop a specific BSP for an unsupported target board.  The
    309 "stubdr" subdirectory provides stubbed out BSPs.  These files
    310 may aid in preliminary testing of the RTEMS development
    311 environment that has been built for no particular target in mind.
     309family, then further broken down into specific target board
     310environments.  The "no_cpu" subdirectory provides a starting point
     311template BSP which can be used to develop a specific BSP for an
     312unsupported target board.  The files in this subdirectory may aid
     313in preliminary testing of the RTEMS development environment that has
     314been built for no particular target in mind.
    312315
    313316Below each CPU dependent directory is a directory for each target BSP
     
    425428This directory contains the RTEMS I2C framework.
    426429
    427 @item $@{RTEMS_ROOT@}/cpukit/libmd/
    428 This directory contains a port of the standard MD5
    429 checksum code.
    430 
    431 @item $@{RTEMS_ROOT@}/c/src/libmisc/
     430@item $@{RTEMS_ROOT@}/cpukit/libmisc/
    432431This directory contains support facilities which
    433432are RTEMS specific but otherwise unclassified.  In
     
    486485processors.
    487486
    488 @item $@{RTEMS_ROOT@}/cpukit/shttpd/
    489 This directory contains the port of the Simple HTTPD
    490 web server to RTEMS.
    491 
    492 @item $@{RTEMS_ROOT@}/cpukit/telnet/
     487@item $@{RTEMS_ROOT@}/cpukit/telnetd/
    493488This directory contains the RTEMS telnetd server.
    494489
     
    510505@c
    511506@section testsuites/ Test Suites
    512 
    513507This directory provides all of the RTEMS Test Suite
    514508except those for the Classic API Ada95 binding
     
    552546Classic API when executing on a single processor.
    553547The tests were originally designed to provide
    554 near complete test coverage for the the entire
     548near complete test coverage for the entire
    555549executive code.  With the addition of multiple APIs,
    556550this is no longer the case as some SuperCore functionality
     
    596590@c
    597591@section Documentation Directory
    598 
    599592This directory contains the source code for all RTEMS documentation
    600593in @code{TexInfo} format as well as utilities used in the generation
     
    604597
    605598@table @code
    606 
    607 @item $@{RTEMS_ROOT@}/doc/user/
    608 This directory contains the source code for the @cite{RTEMS
    609 Applications C User's Guide} which documents the Classic API.
    610599
    611600@item $@{RTEMS_ROOT@}/doc/ada_user/
     
    682671release notes document.  This has not been used for
    683672recent RTEMS releases.
    684 
    685 @item $@{RTEMS_ROOT@}/doc/rgdb_specs/
    686 This directory contains the source code for the
    687 @cite{RTEMS Remote Debugger Server Specifications}.
    688 
    689 @item $@{RTEMS_ROOT@}/doc/rtems_gdb/
    690 This directory contains the source code for the
    691 @cite{RTEMS/GDB User's Guide}.
    692673
    693674@item $@{RTEMS_ROOT@}/doc/started/
     
    707688subsection organization.
    708689
     690@item $@{RTEMS_ROOT@}/doc/user/
     691This directory contains the source code for the @cite{RTEMS
     692Applications C User's Guide} which documents the Classic API.
     693
    709694@end table
  • doc/develenv/sample.t

    r1773d3b r1e121d83  
    2121broken in new BSPs.
    2222
    23 Each of the following sample applications will be listed in
    24 more detail in the following sections:
     23Some of the following sample applications will be covered in
     24more detail in subsequent sections:
    2525
    2626@table @b
     
    2828The RTEMS Hello World test is provided in
    2929the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/hello/}.
    30 This test is helpful when testing new
    31 versions of RTEMS, BSPs, or modifications to any portion of the
    32 RTEMS development environment. 
     30This test is helpful when testing new RTEMS development environment. 
    3331
    3432@item Clock Tick
     
    5149subdirectory provides a simple C++ application using
    5250constructors and destructors.  It is only built when
    53 C++ is enabled. 
    54 
    55 
    56 @item Paranoia Floating Point Test
    57 The directory @code{$@{RTEMS_ROOT@}/testsuites/samples/paranoia/}
    58 contains the public domain floating point and math library test.
     51C++ is enabled and its primary purpose is to demonstrate
     52that global constructors and destructors work.  Since this
     53requires that the linker script for your BSP be correct, this is
     54an important test.
     55
     56@item File IO
     57The RTEMS File IO test is provided in
     58the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/fileio/}.
     59This is an interactive test which allows the user to interact with
     60an ATA/IDE device.  It will read the partition table and allow the
     61user to dynamically mount one of the FAT32 partitions it finds.
     62Commands are also provided to write and read files on the disk.
     63
     64@item IO Stream
     65The RTEMS IO Stream test is provided in
     66the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/iostream/}.
     67This test is a simple C++ application which demonstrates that
     68C++ iostreams are functional. This requires that the RTEMS C++
     69run-time support is functioning properly.  This test is only
     70build when C++ is enabled.
     71
     72@item Network Loopback Test
     73The @code{$@{RTEMS_ROOT@}/testsuites/samples/loopback/}
     74directory contains a sample test that demonstrates the use of
     75sockets and the loopback network device.  It does not require
     76the presence of network hardware in order to run.
     77It is only built if RTEMS was configured with networking enabled.
    5978
    6079@item Minimum Size Test
     
    6584application based upon the current RTEMS configuration. 
    6685
     86@item Paranoia Floating Point Test
     87The directory @code{$@{RTEMS_ROOT@}/testsuites/samples/paranoia/}
     88contains the public domain floating point and math library test.
     89
     90@item Point-to-Point Protocol Daemon
     91The RTEMS Point-to-Point Protocol Daemon test is provided in
     92the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/pppd/}.
     93This test primarily serves as the baseline for a user application
     94using the PPP protocol.
     95
    6796@item Unlimited Object Allocation
    6897The @code{$@{RTEMS_ROOT@}/testsuites/samples/unlimited/}
     
    7099@i{unlimited} object allocation configuration option to RTEMS.
    71100
    72 @item Network Loopback Test
    73 The @code{$@{RTEMS_ROOT@}/testsuites/samples/loopback/}
    74 directory contains a sample test that demonstrates the use of
    75 sockets and the loopback network device.  It does not require
    76 the presence of network hardware in order to run.
    77 It is only built if RTEMS was configured with networking enabled.
    78 
    79101@end table
    80102
     
    83105material presented in the @b{RTEMS Applications Users Guide}.
    84106
     107@c
     108@c
     109@c
    85110@section Hello World
    86111
     
    95120sample application uses the printf function from the RTEMS
    96121Standard C Library to output messages.   The Ada version of this
    97 sample use the TEXT_IO package to output the hello messages.
     122sample uses the TEXT_IO package to output the hello messages.
    98123The following messages are printed:
    99124
     
    111136console output routine is not operating properly.
    112137
     138@c
     139@c
     140@c
    113141@section Clock Tick
    114142
     
    158186operating properly.
    159187
     188@c
     189@c
     190@c
    160191@section Base Single Processor Application
    161192
     
    185216are printed from the single application task.
    186217
     218@c
     219@c
     220@c
    187221@section Base Multiple Processor Application
    188222
     
    234268must be unique on each node.
    235269
     270@c
     271@c
     272@c
    236273@section Constructor/Destructor C++ Application
    237274
     
    280317@end example
    281318
     319@c
     320@c
     321@c
    282322@section Minimum Size Test
    283323
     
    296336hardware shutdown support.
    297337
     338@c
     339@c
     340@c
    298341@section Paranoia Floating Point Application
    299342
     
    314357handlers not installed.
    315358
     359@c
     360@c
     361@c
    316362@section Network Loopback Test
    317363
Note: See TracChangeset for help on using the changeset viewer.