Fix doc errors

Message ID af8f684306d129743f37b607cc6ee15d44d65c9e.1506945936.git.szs@semihalf.com
State New
Headers show
Series
  • Fix doc errors
Related show

Commit Message

Szymon Sliwa Oct. 2, 2017, 12:05 p.m.
odp_pull_head() -> odp_packet_pull_head()
odp_push_head() -> odp_packet_push_head()

and paragraph reformat to comply with the
80 character line limit

Signed-off-by: Szymon Sliwa <szs@semihalf.com>

---
 doc/users-guide/users-guide-packet.adoc | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

-- 
2.7.4

Comments

Bill Fischofer Oct. 2, 2017, 12:19 p.m. | #1
On Mon, Oct 2, 2017 at 7:05 AM, Szymon Sliwa <szs@semihalf.com> wrote:

> odp_pull_head() -> odp_packet_pull_head()

> odp_push_head() -> odp_packet_push_head()

>

> and paragraph reformat to comply with the

> 80 character line limit

>

> Signed-off-by: Szymon Sliwa <szs@semihalf.com>

>


Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>



> ---

>  doc/users-guide/users-guide-packet.adoc | 20 ++++++++++----------

>  1 file changed, 10 insertions(+), 10 deletions(-)

>

> diff --git a/doc/users-guide/users-guide-packet.adoc

> b/doc/users-guide/users-guide-packet.adoc

> index d5f2ff1..f1084e8 100644

> --- a/doc/users-guide/users-guide-packet.adoc

> +++ b/doc/users-guide/users-guide-packet.adoc

> @@ -39,17 +39,17 @@ _payload_, followed by zero or more _trailers_.  Shown

> here are various APIs

>  that permit applications to examine and navigate various parts of a

> packet and

>  to manipulate its structure.

>

> -To support packet manipulation, predefined _headroom_ and _tailroom_

> -areas are logically associated with a packet. Packets can be adjusted by

> -_pulling_ and _pushing_ these areas. Typical packet processing might

> consist

> -of stripping headers from a packet via `odp_pull_head()` calls as part of

> -receive processing and then replacing them with new headers via

> -`odp_push_head()` calls as the packet is being prepared for transmit.

> Note that

> -while headroom and tailroom represent reserved areas of memory, these

> areas

> -not not addressable or directly usable by ODP applications until they are

> +To support packet manipulation, predefined _headroom_ and _tailroom_

> areas are

> +logically associated with a packet. Packets can be adjusted by _pulling_

> and

> +_pushing_ these areas. Typical packet processing might consist of

> stripping

> +headers from a packet via `odp_packet_pull_head()` calls as part of

> receive

> +processing and then replacing them with new headers via

> +`odp_packet_push_head()` calls as the packet is being prepared for

> transmit.

> +Note that while headroom and tailroom represent reserved areas of memory,

> these

> +areas not not addressable or directly usable by ODP applications until

> they are

>  made part of the packet via associated push operations. Similarly, bytes

> -removed via pull operations become part of a packet's headroom or tailroom

> -and are again no longer accessible to the application.

> +removed via pull operations become part of a packet's headroom or

> tailroom and

> +are again no longer accessible to the application.

>

>  === Packet Segments and Addressing

>  ODP platforms use various methods and techniques to store and process

> packets

> --

> 2.7.4

>

>

Patch

diff --git a/doc/users-guide/users-guide-packet.adoc b/doc/users-guide/users-guide-packet.adoc
index d5f2ff1..f1084e8 100644
--- a/doc/users-guide/users-guide-packet.adoc
+++ b/doc/users-guide/users-guide-packet.adoc
@@ -39,17 +39,17 @@  _payload_, followed by zero or more _trailers_.  Shown here are various APIs
 that permit applications to examine and navigate various parts of a packet and
 to manipulate its structure.
 
-To support packet manipulation, predefined _headroom_ and _tailroom_
-areas are logically associated with a packet. Packets can be adjusted by
-_pulling_ and _pushing_ these areas. Typical packet processing might consist
-of stripping headers from a packet via `odp_pull_head()` calls as part of
-receive processing and then replacing them with new headers via
-`odp_push_head()` calls as the packet is being prepared for transmit. Note that
-while headroom and tailroom represent reserved areas of memory, these areas
-not not addressable or directly usable by ODP applications until they are
+To support packet manipulation, predefined _headroom_ and _tailroom_ areas are
+logically associated with a packet. Packets can be adjusted by _pulling_ and
+_pushing_ these areas. Typical packet processing might consist of stripping
+headers from a packet via `odp_packet_pull_head()` calls as part of receive
+processing and then replacing them with new headers via
+`odp_packet_push_head()` calls as the packet is being prepared for transmit.
+Note that while headroom and tailroom represent reserved areas of memory, these
+areas not not addressable or directly usable by ODP applications until they are
 made part of the packet via associated push operations. Similarly, bytes
-removed via pull operations become part of a packet's headroom or tailroom
-and are again no longer accessible to the application.
+removed via pull operations become part of a packet's headroom or tailroom and
+are again no longer accessible to the application.
 
 === Packet Segments and Addressing
 ODP platforms use various methods and techniques to store and process packets