doc: document new compress perf option

Message ID 20191015113751.4581-1-adamx.dybkowski@intel.com (mailing list archive)
State Superseded, archived
Headers
Series doc: document new compress perf option |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Dybkowski, AdamX Oct. 15, 2019, 11:37 a.m. UTC
  This patch documents the new compress perf tool
option --external-mbufs.

Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com>
---
 doc/guides/rel_notes/release_19_11.rst | 5 +++++
 doc/guides/tools/comp_perf.rst         | 2 ++
 2 files changed, 7 insertions(+)
  

Patch

diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
index ba8ad959b..447b665fb 100644
--- a/doc/guides/rel_notes/release_19_11.rst
+++ b/doc/guides/rel_notes/release_19_11.rst
@@ -120,6 +120,11 @@  New Features
   Added eBPF JIT support for arm64 architecture to improve the eBPF program
   performance.
 
+* **Added external buffers support for dpdk-test-compress-perf tool.**
+
+  Added a command line option to dpdk-test-compress-perf tool to allocate
+  and use memory zones as external buffers instead of keeping the data directly
+  in mbuf areas.
 
 Removed Items
 -------------
diff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.rst
index 118de5433..65a168a20 100644
--- a/doc/guides/tools/comp_perf.rst
+++ b/doc/guides/tools/comp_perf.rst
@@ -82,6 +82,8 @@  Application Options
 
  ``--window-sz N``: base two log value of compression window size (default: max supported by PMD)
 
+``--external-mbufs``: allocate and use memzones as external buffers instead of keeping the data directly in mbuf areas
+
  ``-h``: prints this help