diff options
author | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-02-27 19:43:10 +0300 |
---|---|---|
committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-02-27 20:37:29 +0300 |
commit | 49bc9ee8fdd47c6193108a90c94ca3b3de66ba46 (patch) | |
tree | 65f74a2b80668051b66ea8b036de57845af9f2c0 | |
parent | 8ab2f3421cfea165210a2c0d9450e182e327e983 (diff) |
doc: clean up doxygen first page textv1.0.0
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
-rw-r--r-- | doc/odp.dox | 33 |
1 files changed, 6 insertions, 27 deletions
diff --git a/doc/odp.dox b/doc/odp.dox index b58642194..f574e21ae 100644 --- a/doc/odp.dox +++ b/doc/odp.dox @@ -35,37 +35,16 @@ * of ODP, linux-generic is designed to provide best-in-class performance * for general Linux data plane support. * - * @section Staging + * @section ODP Releases * - * ODP is a work in progress and is expected to evolve significantly - * as it develops. Since the goal of ODP is to provide portability - * across disparate platforms and architectures while still providing - * near-native levels of performance on each conforming - * implementation, it is expected that the ODP architecture and the - * APIs presented here will evolve based on the experience in - * implementing and tuning ODP for operation on multiple platforms. - * For the time being, then, the goal here is not so much as to - * present a stable API, but rather a usable one that can be built - * upon to reach a clearly defined end goal. - * - * ODP releases will follow a standard major/minor/revision - * three-level naming designation. The intent is that APIs will be - * stable across major revisions such that existing APIs will work - * unchanged within a major revision, though minor revisions may add - * new APIs. Across major revisions some API changes may make - * application source changes necesary. These will be clearly noted - * in the release notes associated with any given ODP release. - * - * This consistency will commence with the 1.0.0 release of ODP, which - * is expected later in 2014. Pre-release 1 it should be expected - * that minor revisions may require API source changes as ODP is still - * "growing its roots". This is release 0.1.0 of ODP and is being - * made available as a "public preview" to the open source community - * for comment/feedback/evaluation. + * ODP releases follow a standard three-level naming designation. + * Changes to the API are reflected in the #ODP_VERSION_API_GENERATION + * and #ODP_VERSION_API_MAJOR numbers. A change to the #ODP_VERSION_API_MINOR + * number is used only for updates not breaking the API compatibility. * * @section contact Contact Details * - The main web site is http://www.opendataplane.org/ * - The git repo is https://git.linaro.org/lng/odp.git - * - Bug tracking is https://bugs.linaro.org/buglist.cgi?component=General&list_id=2474&product=OpenDataPlane + * - Bug tracking is https://bugs.linaro.org/buglist.cgi?product=OpenDataPlane * */ |