From 653c9de121307fd1bf9f5065fb8e05380c00b5c9 Mon Sep 17 00:00:00 2001 From: Mark Kavanagh Date: Thu, 12 Oct 2017 17:05:29 +0100 Subject: [PATCH] doc: fix GSO guide Correct two minor issues in the GSO programmer's guide: - a note is rendered incorrectly in the middle of an unordered list; this results in the remainder of the list appearing inside the note. Correct indentation of the note to resolve same. - two minor visual artifacts are present in the 'three-part-output-segment' diagram. Remove same. Fixes: f6010c7655cc ("doc: add GSO programmer's guide") Signed-off-by: Mark Kavanagh Acked-by: John McNamara --- .../generic_segmentation_offload_lib.rst | 11 +- .../prog_guide/img/gso-three-seg-mbuf.svg | 116 +++++++++--------- 2 files changed, 64 insertions(+), 63 deletions(-) diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst index 5e78f1625e..4bbf01a462 100644 --- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst +++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst @@ -197,12 +197,13 @@ To segment an outgoing packet, an application must: - a pointer to the mbuf pool for allocating indirect buffers, which are used to locate GSO segments' packet payloads. -.. note:: + .. note:: + + An application may use the same pool for both direct and indirect + buffers. However, since indirect mbufs simply store a pointer, the + application may reduce its memory consumption by creating a separate memory + pool, containing smaller elements, for the indirect pool. - An application may use the same pool for both direct and indirect - buffers. However, since each indirect mbuf simply stores a pointer, the - application may reduce its memory consumption by creating a separate memory - pool, containing smaller elements, for the indirect pool. - the size of each output segment, including packet headers and payload, measured in bytes. diff --git a/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg b/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg index f18a327d17..0431012dea 100644 --- a/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg +++ b/doc/guides/prog_guide/img/gso-three-seg-mbuf.svg @@ -1,9 +1,9 @@ - + + xmlns:v="http://schemas.microsoft.com/visio/2003/SVGExtensions/" width="25.5895in" height="9.63966in" + viewBox="0 0 1842.44 694.055" xml:space="preserve" color-interpolation-filters="sRGB" class="st23"> GSO three-part output segment @@ -132,7 +132,7 @@ - Payload 1 + Payload 1 Sheet.15 @@ -178,21 +178,14 @@ Payload 1 - + Sheet.35 Logical output segment - Logical output segment - - Sheet.38 - Three-part output segment - - - - Three-part output segment - + Logical output segment + Sheet.39 - + Sheet.40 - + Sheet.46 - + Sheet.47 - + Sheet.48 Direct mbuf Direct mbuf - + Sheet.51 (copy of headers) (copy of headers) - + Sheet.53 next next - + Sheet.54 - + Sheet.55 segsz segsz - + Sheet.56 - + Sheet.57 - + Sheet.58 - + Sheet.59 Payload 1 - Payload 1 - + Payload 1 + Sheet.60 Payload 2 Payload 2 - + Sheet.63 Multi-segment input packet - Multi-segment input packet - + Multi-segment input packet + Sheet.70 - + Sheet.71 - - + Sheet.72 Indirect mbuf Indirect mbuf - + Sheet.75 (pointer to data) (pointer to data) - + Sheet.77 next next - + Sheet.78 - + Sheet.79 - + Sheet.80 - + Sheet.81 pkt_len pkt_len - + Sheet.82 % segsz % segsz - + Sheet.34 - + Sheet.85 - + Sheet.87 1 1 - + Sheet.88 - + Sheet.90 2 2 - + Sheet.95 next next - + Sheet.97 - - + Sheet.100 - + Sheet.104 - + Sheet.105 Indirect mbuf Indirect mbuf - + Sheet.106 (pointer to data) (pointer to data) - + Sheet.107 - + Sheet.108 3 3 - + Sheet.109 (pointer to data) (pointer to data) + + Sheet.113 + Three-part output segment + + + + Three-part output segment -- 2.20.1