Changeset 4120668 in rtems-docs


Ignore:
Timestamp:
Oct 28, 2016, 1:05:32 AM (3 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
9aafb39
Parents:
4cacea0
Message:

Update the file list to the 4.11 directory structure.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • develenv/directory.rst

    r4cacea0 r4120668  
    7878    this directory will be discussed in the `c/ Directory`_ section.
    7979
    80 ``${RTEMS_ROOT}/contrib/``
    81     This directory contains contributed support software.  Currently this
    82     directory contains the RPM specifications for cross-compilers hosted on
    83     GNU/Linux that target various operating systems including MinGW, Cygwin,
    84     FreeBSD, and Solaris.  The cross-compilers produced using these
    85     specifications are then used in a Canadian cross build procedure to produce
    86     the various RTEMS toolsets on a GNU/Linux host.  This directory also
    87     contains RPM specifications for the prebuilt cross-compilation toolsets
    88     provided by the RTEMS project.  There are separate subdirectories for each
    89     of the components in the RTEMS Cross Compilation Environment unde the
    90     ``contrib/crossrpms/`` directory.  This directory is configured, built, and
    91     installed separately from the RTEMS executive and tests.  This directory
    92     will not be discussed further in this document.
    93 
    9480``${RTEMS_ROOT}/cpukit/``
    9581    This directory is the root for all of the "multilib'able" portions of
     
    9985    under this directory.  The contents of this directory will be discussed in
    10086    the `CPU Kit Directory`_ section.
    101 
    102 ``${RTEMS_ROOT}/doc/``
    103     This directory is the root for all RTEMS documentation.  The source for
    104     RTEMS is written in GNU TeXinfo and used to produce HTML, PDF, and "info"
    105     files.  The RTEMS documentation is configured, built, and installed
    106     separately from the RTEMS executive and tests.  The contents of this
    107     directory will be discussed in the `Documentation Directory`_ section.
    10887
    10988``${RTEMS_ROOT}/make/``
     
    206185    computer.
    207186
    208 ``${RTEMS_ROOT}/c/src/optman/``
    209     This directory contains stubs for the RTEMS Classic API Managers which are
    210     considered optional and whose use may be explicitly forbidden by an
    211     application.  All of the directive implementations in this Optional
    212     Managers return ``E_NOTCONFIGURED``.
    213 
    214187``${RTEMS_ROOT}/c/src/support/``
    215188    This directory exists solely to generate the RTEMS version string which
     
    290263    This directory contains the RTEMS ftpd server.
    291264
    292 ``${RTEMS_ROOT}/cpukit/httpd/``
    293     This directory contains the port of the GoAhead web server to RTEMS.
     265``${RTEMS_ROOT}/cpukit/mhttpd/``
     266    This directory contains the port of the Mongoose web server to RTEMS.
    294267
    295268``${RTEMS_ROOT}/cpukit/include/``
     
    321294    This directory contains a port of the standard MD5 checksum code.
    322295
    323 ``${RTEMS_ROOT}/c/src/libmisc/``
     296``${RTEMS_ROOT}/cpukit/libmisc/``
    324297    This directory contains support facilities which are RTEMS specific but
    325298    otherwise unclassified.  In general, they do not adhere to a standard API.
     
    369342    for the other ports to specific processors.
    370343
    371 ``${RTEMS_ROOT}/cpukit/shttpd/``
    372     This directory contains the port of the Simple HTTPD web server to RTEMS.
    373 
    374344``${RTEMS_ROOT}/cpukit/telnetd/``
    375345    This directory contains the RTEMS telnetd server.
     
    443413    then the utility ``sorttimes`` will be able to produce a report organizing
    444414    the execution times by manager.
    445 
    446 Documentation Directory
    447 =======================
    448 
    449 This directory contains the source code for all RTEMS documentation in
    450 ``TexInfo`` format as well as utilities used in the generation of the RTEMS
    451 documentation set.  This source code is used to produce the RTEMS documentation
    452 in various formats including PDF, HTML, and PostScript.
    453 
    454 ``${RTEMS_ROOT}/doc/ada_user/``
    455     This directory contains the source code for the *RTEMS Applications Ada
    456     User's Guide* which documents the Ada95 binding to the Classic API.  This
    457     manual is produced from from the same source base as the *RTEMS Application
    458     C User's Guide*.
    459 
    460 ``${RTEMS_ROOT}/doc/bsp_howto/``
    461     This directory contains the source code for the*RTEMS BSP and Device Driver
    462     Development Guide*.
    463 
    464 ``${RTEMS_ROOT}/doc/common/``
    465     This directory contains the source code for the files which are shared
    466     across multiple manuals in the RTEMS Documentation Set.  This includes the
    467     copyright page as well as the timing tables which can be filled in on a per
    468     BSP basis in the CPU supplements.
    469 
    470 ``${RTEMS_ROOT}/doc/cpu_supplement/``
    471     This directory contains the source code for the RTEMS CPU Supplement.
    472 
    473 ``${RTEMS_ROOT}/doc/develenv/``
    474     This directory contains the source code for the*RTEMS Development
    475     Environment Guide*.  This is the document you are currently reading.
    476 
    477 ``${RTEMS_ROOT}/doc/filesystem/``
    478     This directory contains the source code for the*RTEMS Filesystem Design
    479     Guide*.  This manual is a continuous work in process as it attempts to
    480     capture the design of the interface between system calls and filesystem
    481     implementations as well as the information required by those implementing
    482     filesystems.
    483 
    484 ``${RTEMS_ROOT}/doc/images/``
    485     This directory contains the source code for the graphics used in the HTML
    486     version of the RTEMS Documentation.
    487 
    488 ``${RTEMS_ROOT}/doc/networking/``
    489     This directory contains the source code for the*RTEMS Network Supplement*.
    490 
    491 ``${RTEMS_ROOT}/doc/new_chapters/``
    492     This directory contains the source code for the new documentation
    493     components which have not yet been collected into a new manual or merged
    494     into an existing document.  Currently, this primarily contains draft
    495     documentation for some portions of the facilities implemented in
    496     ``${RTEMS_ROOT}/c/src/libmisc/``.
    497 
    498 ``${RTEMS_ROOT}/doc/porting/``
    499     This directory contains the source code for the*RTEMS Porting Guide*.
    500 
    501 ``${RTEMS_ROOT}/doc/posix1003.1/``
    502     This directory contains the source code for the*RTEMS POSIX 1003.1
    503     Compliance Guide*.
    504 
    505 ``${RTEMS_ROOT}/doc/posix_users/``
    506     This directory contains the source code for the*RTEMS POSIX API User's
    507     Guide*.  It is important to note that RTEMS' support for POSIX is a
    508     combination of functionality provided by RTEMS and the Newlib C Library so
    509     some functionality is documented by Newlib.
    510 
    511 ``${RTEMS_ROOT}/doc/relnotes/``
    512     This directory contains the source code for a formally release notes
    513     document.  This has not been used for recent RTEMS releases.
    514 
    515 ``${RTEMS_ROOT}/doc/started/``
    516     This directory contains the source code for the*Getting Started with RTEMS
    517     for C/C++ Users* manual.
    518 
    519 ``${RTEMS_ROOT}/doc/tools/``
    520     This directory contains the source code for the tools used on the
    521     development host to assist in producing the RTEMS Documentation.  The most
    522     important of these tools is ``bmenu`` which generates the hierarchical node
    523     linking commands based upon chapter, section, and subsection organization.
    524 
    525 ``${RTEMS_ROOT}/doc/user/``
    526     This directory contains the source code for the *RTEMS Applications C
    527     User's Guide* which documents the Classic API.
Note: See TracChangeset for help on using the changeset viewer.