diff mbox series

[v2,1/1] doc: document new compress perf option

Message ID 20191015140930.5981-2-adamx.dybkowski@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
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, 2:09 p.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(+)

Comments

Fiona Trahe Oct. 15, 2019, 5:10 p.m. UTC | #1 
> -----Original Message-----
> From: Dybkowski, AdamX
> Sent: Tuesday, October 15, 2019 3:10 PM
> To: dev@dpdk.org; Trahe, Fiona <fiona.trahe@intel.com>
> Cc: Dybkowski, AdamX <adamx.dybkowski@intel.com>
> Subject: [PATCH v2 1/1] doc: document new compress perf option
> 
> This patch documents the new compress perf tool
> option --external-mbufs.
> 
> Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Akhil Goyal Oct. 16, 2019, 8:39 a.m. UTC | #2 
Hi Adam,

> 
> This patch documents the new compress perf tool
> option --external-mbufs.
> 
> Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com>
> ---
This patch should have been merged with the 
" app/compress-perf: add --external-mbufs option"

Please make sure that all documentation related patches go in the corresponding code itself.
No separate patch should be there.

Now since the original patch is merged, you should change the title as
"doc: fix missing compress perf option" or something similar.
Please also add a fixes line for the original commit.

Regards,
Akhil
diff mbox series

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..6c59c8403 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