Re: [lng-odp] [PATCHv4] doc: userguide: add application programming section

[Maxim Uvarov]

Merged,
Maxim.

On 12/11/2015 21:51, Mike Holmes wrote:


On 11 December 2015 at 12:23, Bill Fischofer 
> wrote:


Complete the reformatting to standard asciidoc style, expand the
ODP Application Programming section, and include a reorganized and
expanded discussion of ODP queues.

Signed-off-by: Bill Fischofer >


Reviewed-by: Mike Holmes >


Mike

---
 doc/users-guide/users-guide.adoc | 450
+++
 1 file changed, 358 insertions(+), 92 deletions(-)

diff --git a/doc/users-guide/users-guide.adoc
b/doc/users-guide/users-guide.adoc
index cf77fa0..2e30f3a 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -8,16 +8,19 @@ OpenDataPlane (ODP)  Users-Guide
 Abstract
 
 This document is intended to guide a new ODP application developer.
-Further details about ODP may be found at the
http://opendataplane.org[ODP] home page.
+Further details about ODP may be found at the
http://opendataplane.org[ODP]
+home page.

 .Overview of a system running ODP applications
 image::../images/overview.png[align="center"]

-ODP is an API specification that allows many implementations to
provide platform independence, automatic hardware acceleration and
CPU scaling to high performance networking  applications.
-This document describes how to write an application that can
successfully take advantage of the API.
+ODP is an API specification that allows many implementations to
provide
+platform independence, automatic hardware acceleration and CPU
scaling to
+high performance networking  applications. This document
describes how to
+write an application that can successfully take advantage of the API.

 :numbered:
-== Introduction ==
+== Introduction
 .OpenDataPlane Components
 image::../images/odp_components.png[align="center"]

@@ -42,7 +45,7 @@ ODP API specification--that is the
responsibility of each ODP implementation.
 * Application-centric.  Covers functional needs of data plane
applications.
 * Ensures portability by specifying the functional behavior of ODP.
 * Defined jointly and openly by application writers and platform
implementers.
-* Archiected to be implementable on a wide range of platforms
efficiently
+* Architected to be implementable on a wide range of platforms
efficiently
 * Sponsored, governed, and maintained by the Linaro Networking
Group (LNG)

 .ODP Implementations
@@ -68,7 +71,7 @@ where the application will run on a target
platform chosen by someone else.
 * One size does not fit all--supporting multiple implementations
allows ODP
 to adapt to widely differing internals among platforms.
 * Anyone can create an ODP implementation tailored to their platform
-* Distribution and mainteinance of each implementation is as
owner wishes
+* Distribution and maintenance of each implementation is as owner
wishes
   - Open source or closed source as business needs determine
   - Have independent release cycles and service streams
 * Allows HW and SW innovation in how ODP APIs are implemented on
each platform.
@@ -100,7 +103,7 @@ drivers supported by DPDK.
 they are derived from a reference implementation.

 .ODP Validation Test Suite
-Third, to enure consistency between different ODP
implementations, ODP
+Third, to ensure consistency between different ODP
implementations, ODP
 consists of a validation suite that verifies that any given
implementation of
 ODP faithfully provides the specified functional behavior of each
ODP API.
 As a separate open source component, the validation suite may be
used by
@@ -115,16 +118,16 @@ ODP API specification.
 * Key to ensuring application portability across all ODP
implementations
 * Tests that ODP implementations conform to the specified
functional behavior
 of ODP APIs.
-* Can be run at any time by users and vendors to validat
implementations
-od ODP.
+* Can be run at any time by users and vendors to validate
implementations
+of ODP.

-=== ODP API Specification Versioning ===
+=== ODP API Specification Versioning
 As an evolving standard, the ODP API specification is released
under an
 incrementing version number, and corresponding implementations of
ODP, as well
 as the validation suite that verifies API conformance, are linked
to this
-version number. ODP versions are specified using a stanard
three-level
+version number. ODP versions are specified using a standard
three-level
 number 

[lng-odp] [PATCHv4] doc: userguide: add application programming section

[Bill Fischofer]

Complete the reformatting to standard asciidoc style, expand the
ODP Application Programming section, and include a reorganized and
expanded discussion of ODP queues.

Signed-off-by: Bill Fischofer 
---
 doc/users-guide/users-guide.adoc | 450 +++
 1 file changed, 358 insertions(+), 92 deletions(-)

diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index cf77fa0..2e30f3a 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -8,16 +8,19 @@ OpenDataPlane (ODP)  Users-Guide
 Abstract
 
 This document is intended to guide a new ODP application developer.
-Further details about ODP may be found at the http://opendataplane.org[ODP] 
home page.
+Further details about ODP may be found at the http://opendataplane.org[ODP]
+home page.
 
 .Overview of a system running ODP applications
 image::../images/overview.png[align="center"]
 
-ODP is an API specification that allows many implementations to provide 
platform independence, automatic hardware acceleration and CPU scaling to high 
performance networking  applications.
-This document describes how to write an application that can successfully take 
advantage of the API.
+ODP is an API specification that allows many implementations to provide
+platform independence, automatic hardware acceleration and CPU scaling to
+high performance networking  applications. This document describes how to
+write an application that can successfully take advantage of the API.
 
 :numbered:
-== Introduction ==
+== Introduction
 .OpenDataPlane Components
 image::../images/odp_components.png[align="center"]
 
@@ -42,7 +45,7 @@ ODP API specification--that is the responsibility of each ODP 
implementation.
 * Application-centric.  Covers functional needs of data plane applications.
 * Ensures portability by specifying the functional behavior of ODP.
 * Defined jointly and openly by application writers and platform implementers.
-* Archiected to be implementable on a wide range of platforms efficiently
+* Architected to be implementable on a wide range of platforms efficiently
 * Sponsored, governed, and maintained by the Linaro Networking Group (LNG)
 
 .ODP Implementations
@@ -68,7 +71,7 @@ where the application will run on a target platform chosen by 
someone else.
 * One size does not fit all--supporting multiple implementations allows ODP
 to adapt to widely differing internals among platforms.
 * Anyone can create an ODP implementation tailored to their platform
-* Distribution and mainteinance of each implementation is as owner wishes
+* Distribution and maintenance of each implementation is as owner wishes
   - Open source or closed source as business needs determine
   - Have independent release cycles and service streams
 * Allows HW and SW innovation in how ODP APIs are implemented on each platform.
@@ -100,7 +103,7 @@ drivers supported by DPDK.
 they are derived from a reference implementation.
 
 .ODP Validation Test Suite
-Third, to enure consistency between different ODP implementations, ODP
+Third, to ensure consistency between different ODP implementations, ODP
 consists of a validation suite that verifies that any given implementation of
 ODP faithfully provides the specified functional behavior of each ODP API.
 As a separate open source component, the validation suite may be used by
@@ -115,16 +118,16 @@ ODP API specification.
 * Key to ensuring application portability across all ODP implementations
 * Tests that ODP implementations conform to the specified functional behavior
 of ODP APIs.
-* Can be run at any time by users and vendors to validat implementations
-od ODP.
+* Can be run at any time by users and vendors to validate implementations
+of ODP.
 
-=== ODP API Specification Versioning ===
+=== ODP API Specification Versioning
 As an evolving standard, the ODP API specification is released under an
 incrementing version number, and corresponding implementations of ODP, as well
 as the validation suite that verifies API conformance, are linked to this
-version number. ODP versions are specified using a stanard three-level
+version number. ODP versions are specified using a standard three-level
 number (major.minor.fixlevel) that are incremented according to the degree of
-change the level represents. Increments to the fixlevel represent clarification
+change the level represents. Increments to the fix level represent 
clarification
 of the specification or other minor changes that do not affect either the
 syntax or semantics of the specification. Such changes in the API specification
 are expected to be rare. Increments to the minor level
@@ -136,26 +139,26 @@ the major level represent significant structural changes 
that most likely
 require some level of application source code change, again as documented in
 the release notes for that version.
 
-=== ODP Implementation Versioning ===
+=== ODP Implementation Versioning
 ODP 

Re: [lng-odp] [PATCHv4] doc: userguide: add application programming section

[Mike Holmes]

On 11 December 2015 at 12:23, Bill Fischofer 
wrote:

> Complete the reformatting to standard asciidoc style, expand the
> ODP Application Programming section, and include a reorganized and
> expanded discussion of ODP queues.
>
> Signed-off-by: Bill Fischofer 
>

Reviewed-by: Mike Holmes 

Mike



> ---
>  doc/users-guide/users-guide.adoc | 450
> +++
>  1 file changed, 358 insertions(+), 92 deletions(-)
>
> diff --git a/doc/users-guide/users-guide.adoc
> b/doc/users-guide/users-guide.adoc
> index cf77fa0..2e30f3a 100644
> --- a/doc/users-guide/users-guide.adoc
> +++ b/doc/users-guide/users-guide.adoc
> @@ -8,16 +8,19 @@ OpenDataPlane (ODP)  Users-Guide
>  Abstract
>  
>  This document is intended to guide a new ODP application developer.
> -Further details about ODP may be found at the http://opendataplane.org[ODP]
> home page.
> +Further details about ODP may be found at the http://opendataplane.org
> [ODP]
> +home page.
>
>  .Overview of a system running ODP applications
>  image::../images/overview.png[align="center"]
>
> -ODP is an API specification that allows many implementations to provide
> platform independence, automatic hardware acceleration and CPU scaling to
> high performance networking  applications.
> -This document describes how to write an application that can successfully
> take advantage of the API.
> +ODP is an API specification that allows many implementations to provide
> +platform independence, automatic hardware acceleration and CPU scaling to
> +high performance networking  applications. This document describes how to
> +write an application that can successfully take advantage of the API.
>
>  :numbered:
> -== Introduction ==
> +== Introduction
>  .OpenDataPlane Components
>  image::../images/odp_components.png[align="center"]
>
> @@ -42,7 +45,7 @@ ODP API specification--that is the responsibility of
> each ODP implementation.
>  * Application-centric.  Covers functional needs of data plane
> applications.
>  * Ensures portability by specifying the functional behavior of ODP.
>  * Defined jointly and openly by application writers and platform
> implementers.
> -* Archiected to be implementable on a wide range of platforms efficiently
> +* Architected to be implementable on a wide range of platforms efficiently
>  * Sponsored, governed, and maintained by the Linaro Networking Group (LNG)
>
>  .ODP Implementations
> @@ -68,7 +71,7 @@ where the application will run on a target platform
> chosen by someone else.
>  * One size does not fit all--supporting multiple implementations allows
> ODP
>  to adapt to widely differing internals among platforms.
>  * Anyone can create an ODP implementation tailored to their platform
> -* Distribution and mainteinance of each implementation is as owner wishes
> +* Distribution and maintenance of each implementation is as owner wishes
>- Open source or closed source as business needs determine
>- Have independent release cycles and service streams
>  * Allows HW and SW innovation in how ODP APIs are implemented on each
> platform.
> @@ -100,7 +103,7 @@ drivers supported by DPDK.
>  they are derived from a reference implementation.
>
>  .ODP Validation Test Suite
> -Third, to enure consistency between different ODP implementations, ODP
> +Third, to ensure consistency between different ODP implementations, ODP
>  consists of a validation suite that verifies that any given
> implementation of
>  ODP faithfully provides the specified functional behavior of each ODP API.
>  As a separate open source component, the validation suite may be used by
> @@ -115,16 +118,16 @@ ODP API specification.
>  * Key to ensuring application portability across all ODP implementations
>  * Tests that ODP implementations conform to the specified functional
> behavior
>  of ODP APIs.
> -* Can be run at any time by users and vendors to validat implementations
> -od ODP.
> +* Can be run at any time by users and vendors to validate implementations
> +of ODP.
>
> -=== ODP API Specification Versioning ===
> +=== ODP API Specification Versioning
>  As an evolving standard, the ODP API specification is released under an
>  incrementing version number, and corresponding implementations of ODP, as
> well
>  as the validation suite that verifies API conformance, are linked to this
> -version number. ODP versions are specified using a stanard three-level
> +version number. ODP versions are specified using a standard three-level
>  number (major.minor.fixlevel) that are incremented according to the
> degree of
> -change the level represents. Increments to the fixlevel represent
> clarification
> +change the level represents. Increments to the fix level represent
> clarification
>  of the specification or other minor changes that do not affect either the
>  syntax or semantics of the specification. Such changes in the API
> specification
>  are expected to