[dpdk-stable] patch 'doc: clarify data plane error handling in compressdev' has been queued to LTS release 18.11.3

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 09/03/19. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/8e5fbdfa04c67425e279d804c9b3bb051387383d

Thanks.

Kevin Traynor

---
>From 8e5fbdfa04c67425e279d804c9b3bb051387383d Mon Sep 17 00:00:00 2001
From: Fiona Trahe <fiona.trahe at intel.com>
Date: Wed, 15 May 2019 12:16:07 +0100
Subject: [PATCH] doc: clarify data plane error handling in compressdev

[ upstream commit f7095d41bba6ae30d9756dfbe677256851ff879d ]

Fixed some typos and clarified how errors on ops which
fail to get submitted on the enqueue API should be handled.

Fixes: a584d3bea902 ("doc: add compressdev library guide")

Signed-off-by: Fiona Trahe <fiona.trahe at intel.com>
Acked-by: Tomasz Jozwiak <tomaszx.jozwiak at intel.com>
Acked-by: Shally Verma <shallyv at marvell.com>
---
 doc/guides/prog_guide/compressdev.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/doc/guides/prog_guide/compressdev.rst b/doc/guides/prog_guide/compressdev.rst
index 0f572f970..0e8d8c3d1 100644
--- a/doc/guides/prog_guide/compressdev.rst
+++ b/doc/guides/prog_guide/compressdev.rst
@@ -202,5 +202,5 @@ Operation Status
 ~~~~~~~~~~~~~~~~
 Each operation carries a status information updated by PMD after it is processed.
-following are currently supported status:
+Following are currently supported:
 
 - RTE_COMP_OP_STATUS_SUCCESS,
@@ -228,4 +228,14 @@ following are currently supported status:
     next op in the stream should continue on from op.consumed+1.
 
+Operation status after enqueue / dequeue
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Some of the above values may arise in the op after an
+``rte_compressdev_enqueue_burst()``. If number ops enqueued < number ops requested then
+the app should check the op.status of nb_enqd+1. If status is RTE_COMP_OP_STATUS_NOT_PROCESSED,
+it likely indicates a full-queue case for a hardware device and a retry after dequeuing some ops is likely
+to be successful. If the op holds any other status, e.g. RTE_COMP_OP_STATUS_INVALID_ARGS, a retry with
+the same op is unlikely to be successful.
+
+
 Produced, Consumed And Operation Status
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -234,6 +244,6 @@ Produced, Consumed And Operation Status
     consumed = amount of data read from input buffer, and
     produced = amount of data written in destination buffer
-- If status is RTE_COMP_OP_STATUS_FAILURE,
-    consumed = produced = 0 or undefined
+- If status is RTE_COMP_OP_STATUS_ERROR,
+    consumed = produced = undefined
 - If status is RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED,
     consumed = 0 and
-- 
2.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-08-27 09:40:12.277229495 +0100
+++ 0025-doc-clarify-data-plane-error-handling-in-compressdev.patch	2019-08-27 09:40:10.908144679 +0100
@@ -1 +1 @@
-From f7095d41bba6ae30d9756dfbe677256851ff879d Mon Sep 17 00:00:00 2001
+From 8e5fbdfa04c67425e279d804c9b3bb051387383d Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit f7095d41bba6ae30d9756dfbe677256851ff879d ]
+
@@ -10 +11,0 @@
-Cc: stable at dpdk.org
@@ -20 +21 @@
-index 07332d004..dd3e40bff 100644
+index 0f572f970..0e8d8c3d1 100644