introduction.sgml

开放源码实时操作系统源码.

<PARA>This document will use the POSIX shell convention of forward
slashes throughout.</PARA>

</SECT1>

<!-- ==================================================== -->

<SECT1 ID="VERSION-CONVENTIONS">
<TITLE>Version Conventions</TITLE>

<para>
This manual does not refer explicitly to any particular version of
<productname>eCos</productname>. However, version numbers form part of
many file path names. In all of these places the version number will
be shown like this: <replaceable>&Version;</replaceable>.
</para>

<para>
If you have used anonymous CVS to check
<productname>eCos</productname> out of the CVS repository, the version
number will always be <literal>current</literal>, since that is the
name of the directory in the repository. When a stable release is made
this directory name is changed, in the release, to the number of the
release, for example <literal>v2_0</literal> or
<literal>v2_1</literal>.
</para>

</SECT1>


</chapter>



<chapter id="documentation-roadmap">
<title>Documentation Roadmap</title>

<para>
The <productname>eCos</productname> documentation is divided into a
three main parts:
</para>

<VARIABLELIST>
<VARLISTENTRY>
<TERM><EMPHASIS>User Guide</EMPHASIS></TERM>
<LISTITEM>
<PARA>This document. It includes the following sections:</PARA>

  <VARIABLELIST>
  <VARLISTENTRY>
  <TERM>Installing <productname>eCos</productname></TERM>
  <LISTITEM>
  <para>
  This section describes how to install the
  <productname>eCos</productname> software, how to set up your
  hardware and how to test that it is all working.
  </para>
  </listitem>
  </varlistentry>

  <VARLISTENTRY>
  <TERM>Programming Under <productname>eCos</productname></TERM>
  <LISTITEM>
  <para>
  This section describes how to write programs that run under
  <productname>eCos</productname> by running through some examples.
  </para>
  </listitem>
  </varlistentry>

  <VARLISTENTRY>
  <TERM>The <productname>eCos</productname> <application>Configuration Tool</application></TERM>
  <LISTITEM>
  <para>
  This section describes the <productname>eCos</productname> graphical
  configuration tool and how to use it to change how
  <productname>eCos</productname> behaves.</para>
  </listitem>
  </varlistentry>

  <VARLISTENTRY>
  <TERM><productname>eCos</productname> Programming Concepts and Techniques</TERM>
  <LISTITEM>
  <PARA>An explanation of the <productname>eCos</productname> programming
	    cycle, and a description of some debugging facilities that
	    <productname>eCos</productname> offers.
  </PARA>
  </listitem>
  </varlistentry>

  <VARLISTENTRY>
  <TERM>Configuration and the Package
              Repository</TERM>
  <LISTITEM>
  <PARA>Information on how to configure <productname>eCos</productname>
              manually, including a reference on the
              <command>ecosconfig</command> command, memory layouts,
              and information on how to manage a package repository
              using the <productname>eCos</productname> Package Administration
              Tool.
            </PARA>
  </LISTITEM>
  </VARLISTENTRY>


  </variablelist>

</LISTITEM>
</VARLISTENTRY>

<VARLISTENTRY>
<TERM><EMPHASIS>Reference Guide</EMPHASIS></TERM>
<LISTITEM>

<PARA>The Reference Guide provides detailed documentation on various
aspects of <productname>eCos</productname>. This document is being
constantly updated, so the following list just mentions the more
important sections, take a look at the guide itself for the full
story.</PARA>

  <variablelist>

  <VARLISTENTRY>
  <TERM>The <productname>eCos</productname> Kernel</TERM>
  <LISTITEM>
  <PARA>In-depth description of <productname>eCos</productname>&quot;s
              native C kernel API Important considerations are given
              for programming the <productname>eCos</productname>
              kernel. The semantics for each kernel function are
              described, including how they are affected by
              configuration. </PARA>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>POSIX and &micro;ITRON APIs</TERM>
  <LISTITEM>
  <PARA>A description of the POSIX and &micro;ITRON APIs and how they
  are supported under <productname>eCos</productname>.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>The <productname>eCos</productname> Hardware Abstraction Layer (HAL)</TERM>
  <LISTITEM>
  <PARA>A description of the structure and functionality of the
  <productname>eCos</productname> HAL. This section also includes a
  porting guide to help moving <productname>eCos</productname> to
  different platforms.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>Device Drivers</TERM>
  <LISTITEM>
  <PARA>A description of the philosophy behind
              <productname>eCos</productname> device drivers, as well as a
              presentation of the C language APIs for using the current
              device drivers. </PARA>
  <para>
    Device driver support includes serial, ethernet and FLASH devices,
    and support for PCI, PCMCIA and USB interconnects.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>RedBoot User's Guide</TERM>
  <LISTITEM>
  <PARA>This describes RedBoot, which provides a complete bootstrap
        environment for a range of embedded operating systems, such as
        embedded Linux and <productname>eCos</productname>, and
        includes facilities such as network downloading and
        debugging. It also provides a simple flash file system for
        boot images.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>TCP/IP Stack Support</TERM>
  <LISTITEM>
  <PARA>This describes the Common Networking for
        <productname>eCos</productname> package, which provides
        support for a complete TCP/IP networking stack. The design
        allows for the actual stack to be modular and at the current
        time two different implementations, one based on OpenBSD from
        2000 and a new version based on FreeBSD, are available.
  </para>
  <para>Other components related to networking, including support for
        SNMP, DNS, HTTP and FTP, are also described.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  </variablelist>

</LISTITEM>
</VARLISTENTRY>

<VARLISTENTRY>
<TERM><EMPHASIS>Component Writer's Guide</EMPHASIS></TERM>
<LISTITEM>
<PARA>The Component Writer's Guide is intended for developers who need
to add or modify parts of <productname>eCos</productname> itself. It
describes the following things:
</PARA>

  <VARIABLELIST>
  <VARLISTENTRY>
  <TERM>Overview</TERM>
  <LISTITEM>
  <PARA>An explanation of the configuration technology used in
  <productname>eCos</productname>, why it is done this way, how it
  works and the terminology used.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>Package Organization</TERM>
  <LISTITEM>
  <PARA>A description of the <productname>eCos</productname> package
  repository, how it is organized and how packages themselves are
  organized.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>The CDL Language</TERM>
  <LISTITEM>
  <PARA>A description of the CDL language and how it is used to
  control the configuration of <productname>eCos</productname>
  components. The document also contains a complete specification of
  the language.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  <VARLISTENTRY>
  <TERM>The Build Process</TERM>
  <LISTITEM>
  <PARA>A description of what happens once a configuration has been
  created and must be built into a set of executables.
  </para>
  </LISTITEM>
  </VARLISTENTRY>

  </variablelist>

</LISTITEM>
</VARLISTENTRY>
</variablelist>

</chapter>


</part>