[ECOS] C++ API Reference manual

[Nick Garnett]

NavEcos <ecos@navosha.com> writes:

> If anybody is interested my company has produced a little reference
> manual that may be of use to other people.  It documents the C++
> kernel interface.
> 
> The document is "alpha" meaning it may have plenty of errors and/or
> mistakes or it may not.  If you spot any errors and point them out
> to me I will update and correct the document.  The accuracy of the API
> is directly related to how often I used that feature of the API.  Some of
> the features I've never used.
> 
> You may find it here:
> 
> http://navosha.dynu.com
> 
> I created this document as an excercise to get to know some of the
> lesser known features of eCos.  I also have noticed that the C++
> interface is more feature rich than the C interface.
> 
> I've put it more or less under the open publication license
> (http://www.opencontent.org/openpub/) the same license that many  of
> the eCos documents are already under.
> 

Good work, but be careful. There is no guarantee that the C++
interface will remain constant. It was designed as an internal
interface for use by the components of eCos -- which is why it has
never been documented, we don't want users to rely on it.  We have
made significant changes to it in the past and may do so again in the
future.

Only the C API, POSIX and uITRON are guaranteed to remain backward
compatible. I always strongly advise people against using the C++
interface from applications.

I would suggest adding a warning to this effect at the start of the
document.

-- 
Nick Garnett - eCos Kernel Architect
http://www.eCosCentric.com/


-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss