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

[Mike Holmes]

The checkpatch warning is not present with the CI like version of Ubuntu
[1], I see that on 15.04 it is not a checkpatch issue.

[1] https://hub.docker.com/r/roxell/check-odp-ubuntu/



On 11 December 2015 at 10:18, Mike Holmes  wrote:

>
>
> On 11 December 2015 at 10:08, Bill Fischofer 
> wrote:
>
>> The problem is that this is documentation text (pseudocode) not code and
>> yet some tools insist on trying to treat it as if it's a code patch.
>> Checkpatch should not apply to documentation this way.
>>
>
> In this case then we need to turn all the other spaces to tabs becasue now
> we have a mix.
> I want to keep it consistent one way or the other or reviewing will be
> difficult depending on the viewers tab setting.
>
> +...thread init processing
> +
> +while (1) {
> +odp_event_t ev;   <-- only this one is newly tabbed
> +   odp_queue_t which_q;
> +   ev = odp_schedule(_q, );
> +   ...process the event
> +}
> +
>
>
> I honestly think it is just easier to not use tabs in the docs.
>
>
>
>>
>> On Fri, Dec 11, 2015 at 9:04 AM, Mike Holmes 
>> wrote:
>>
>>> Using patch:
>>> lng-odp_PATCHv3_doc_userguide_add_application_programming_section.mbox
>>>   Trying to apply patch
>>>   Patch applied
>>> Applying: doc: userguide: add application programming section
>>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:446:
>>> indent with spaces.
>>> odp_event_t ev;
>>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:613:
>>> indent with spaces.
>>> odp_init_local();
>>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:616:
>>> indent with spaces.
>>> while (1) {
>>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:617:
>>> indent with spaces.
>>>ev = odp_schedule(_q, ODP_SCHED_WAIT);
>>> warning: 4 lines add whitespace errors.
>>> 0001-doc-userguide-add-application-programming-section.patch: unified
>>> diff output, UTF-8 Unicode text
>>>
>>> When I look at all these with git show I see a tab got in there rather
>>> than a space which is inconsistent with the rest of the text.
>>>
>>> Do you have the .gitconfig whitespace =
>>> trailing-space,space-before-tab,indent-with-non-tab,error-all if not you
>>> may not be seeing some things.
>>>
>>>
>>>
>>>
>>>
>>> On 8 December 2015 at 17:36, 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 
 ---
  doc/users-guide/users-guide.adoc | 451
 +++
  1 file changed, 359 insertions(+), 92 deletions(-)

 diff --git a/doc/users-guide/users-guide.adoc
 b/doc/users-guide/users-guide.adoc
 index cf77fa0..d660fb8 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)

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

[Mike Holmes]

On 11 December 2015 at 10:08, Bill Fischofer 
wrote:

> The problem is that this is documentation text (pseudocode) not code and
> yet some tools insist on trying to treat it as if it's a code patch.
> Checkpatch should not apply to documentation this way.
>

In this case then we need to turn all the other spaces to tabs becasue now
we have a mix.
I want to keep it consistent one way or the other or reviewing will be
difficult depending on the viewers tab setting.

+...thread init processing
+
+while (1) {
+odp_event_t ev;   <-- only this one is newly tabbed
+   odp_queue_t which_q;
+   ev = odp_schedule(_q, );
+   ...process the event
+}
+


I honestly think it is just easier to not use tabs in the docs.



>
> On Fri, Dec 11, 2015 at 9:04 AM, Mike Holmes 
> wrote:
>
>> Using patch:
>> lng-odp_PATCHv3_doc_userguide_add_application_programming_section.mbox
>>   Trying to apply patch
>>   Patch applied
>> Applying: doc: userguide: add application programming section
>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:446:
>> indent with spaces.
>> odp_event_t ev;
>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:613:
>> indent with spaces.
>> odp_init_local();
>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:616:
>> indent with spaces.
>> while (1) {
>> /home/mike/git/check-odp/build/odp-apply/.git/rebase-apply/patch:617:
>> indent with spaces.
>>ev = odp_schedule(_q, ODP_SCHED_WAIT);
>> warning: 4 lines add whitespace errors.
>> 0001-doc-userguide-add-application-programming-section.patch: unified
>> diff output, UTF-8 Unicode text
>>
>> When I look at all these with git show I see a tab got in there rather
>> than a space which is inconsistent with the rest of the text.
>>
>> Do you have the .gitconfig whitespace =
>> trailing-space,space-before-tab,indent-with-non-tab,error-all if not you
>> may not be seeing some things.
>>
>>
>>
>>
>>
>> On 8 December 2015 at 17:36, 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 
>>> ---
>>>  doc/users-guide/users-guide.adoc | 451
>>> +++
>>>  1 file changed, 359 insertions(+), 92 deletions(-)
>>>
>>> diff --git a/doc/users-guide/users-guide.adoc
>>> b/doc/users-guide/users-guide.adoc
>>> index cf77fa0..d660fb8 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