Message ID | 1425057103-24638-1-git-send-email-maxim.uvarov@linaro.org |
---|---|
State | New |
Headers | show |
On 27 February 2015 at 12:11, Maxim Uvarov <maxim.uvarov@linaro.org> wrote: > Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> > --- > doc/odp.dox | 31 +++++-------------------------- > 1 file changed, 5 insertions(+), 26 deletions(-) > > diff --git a/doc/odp.dox b/doc/odp.dox > index b586421..9897279 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 follow a standard > + * > #ODP_VERSION_API_GENERATION/#ODP_VERSION_API_MAJOR/#ODP_VERSION_API_MINOR > This renders a little strange try @ref odp_ver_abt_log_dbg to link to that section ? > + * three-level naming designation. > * > - * 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. > * > * @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 > * > */ > -- > 1.8.5.1.163.gd7aced9 > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp >
On Fri, Feb 27, 2015 at 11:11 AM, Maxim Uvarov <maxim.uvarov@linaro.org> wrote: > Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > doc/odp.dox | 31 +++++-------------------------- > 1 file changed, 5 insertions(+), 26 deletions(-) > > diff --git a/doc/odp.dox b/doc/odp.dox > index b586421..9897279 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 follow a standard > + * > #ODP_VERSION_API_GENERATION/#ODP_VERSION_API_MAJOR/#ODP_VERSION_API_MINOR > + * three-level naming designation. > * > - * 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. > * > * @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 > * > */ > -- > 1.8.5.1.163.gd7aced9 > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp >
diff --git a/doc/odp.dox b/doc/odp.dox index b586421..9897279 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 follow a standard + * #ODP_VERSION_API_GENERATION/#ODP_VERSION_API_MAJOR/#ODP_VERSION_API_MINOR + * three-level naming designation. * - * 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. * * @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 * */
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> --- doc/odp.dox | 31 +++++-------------------------- 1 file changed, 5 insertions(+), 26 deletions(-)