Re: [ECOS] docs?

[Bart Veer <bartv at redhat dot com>]

>>>>> "Paul" == Paul Kinzelman <PaulK@isdcorp.com> writes:

    Paul> Could somebody please tell me if there is any documentation
    Paul> describing how to do a real project on eCos rather than just
    Paul> running pre-made tests? Or is all documentation in the code
    Paul> itself? Any API docs?

The documentation is shipped with the releases, and is also available
online at http://sourceware.cygnus.com/ecos/docs-1.3.1/
Both HTML and PDF formats are supported.

The Getting Started Guide deals with installation, setting up the
hardware, building a "Hello world", and moves on to somewhat more
complicated programs involving threads and alarms. It is hard to go
much further than this: where you want to go next depends pretty much
on what kind of embedded application you are planning to develop, and
what hardware you intend to use.

The User's Guide describes how to configure the system, and gives more
formal details of application development e.g. what compiler flags to
use.

The Reference Manual contains various API specs, including the kernel.
Other API's like the C library or uITRON are not described in any
detail since there are other sources of documentation for these -
there seems to be little point in us writing yet another C library
manual, for now the time would be better spent documenting other parts
of the system or improving the existing documentation.

The Component Writer's Guide is for developers who intend to produce
new packages, either freely available ones or commercial ones. If your
intention is simply developing an application then this guide may be
of little interest to you.

Initial documentation for the TCP/IP stack beta is at
http://sourceware.cygnus.com/ecos/tcpip/

Bart Veer // eCos net maintainer