DPDK patches and discussions
 help / color / mirror / Atom feed
From: Vipin Varghese <vipin.varghese@amd.com>
To: <dev@dpdk.org>, <fengchengwen@huawei.com>
Cc: <ferruh.yigit@amd.com>, <neerav.parikh@amd.com>
Subject: [PATCH v2] doc: update size parameter details
Date: Tue, 12 Mar 2024 09:52:01 +0530	[thread overview]
Message-ID: <20240312042201.157-1-vipin.varghese@amd.com> (raw)
In-Reply-To: <20231212104508.1941-1-vipin.varghese@amd.com>

For configuration parameters `mem_size` and `buf_size` are represented
as megabytes and bytes respectively in application. Update the
documentation and to represent the same.

V2 Changes:
 - add mem_size and buf_size in config.ini, suggested by Chengwen.

Signed-off-by: Vipin Varghese <vipin.varghese@amd.com>
---
---
 app/test-dma-perf/config.ini | 4 ++--
 doc/guides/tools/dmaperf.rst | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini
index b550f4b23f..17aa91c22d 100644
--- a/app/test-dma-perf/config.ini
+++ b/app/test-dma-perf/config.ini
@@ -5,8 +5,8 @@
 ; Supported test types are DMA_MEM_COPY and CPU_MEM_COPY.
 
 ; Parameters:
-; "mem_size" denotes the size of the memory footprint.
-; "buf_size" denotes the memory size of a single operation.
+; "mem_size" denotes the size of the memory footprint in megabytes (MB) for source and destination.
+; "buf_size" denotes the memory size of a single operation in bytes (B).
 ; "dma_ring_size" denotes the dma ring buffer size. It should be must be a power of two, and between
 ;  64 and 4096.
 ; "kick_batch" denotes the dma operation batch size, and should be greater than 1 normally.
diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst
index 9e3e78a6b7..6f85fceb8a 100644
--- a/doc/guides/tools/dmaperf.rst
+++ b/doc/guides/tools/dmaperf.rst
@@ -74,10 +74,10 @@ Configuration Parameters
   Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``.
 
 ``mem_size``
-  The size of the memory footprint.
+  The size of the memory footprint in megabytes (MB) for source and destination.
 
 ``buf_size``
-  The memory size of a single operation.
+  The memory size of a single operation in bytes (B).
 
 ``dma_ring_size``
   The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.
-- 
2.39.3


  parent reply	other threads:[~2024-03-12  4:22 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-12 10:45 [PATCH] " Vipin Varghese
2024-03-06  6:08 ` Varghese, Vipin
2024-03-07 13:27 ` fengchengwen
2024-03-07 15:50   ` Varghese, Vipin
2024-03-12  4:22 ` Vipin Varghese [this message]
2024-03-12  6:07   ` [PATCH v2] " fengchengwen
2024-03-12  6:17     ` fengchengwen
2024-03-18  2:47       ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240312042201.157-1-vipin.varghese@amd.com \
    --to=vipin.varghese@amd.com \
    --cc=dev@dpdk.org \
    --cc=fengchengwen@huawei.com \
    --cc=ferruh.yigit@amd.com \
    --cc=neerav.parikh@amd.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).