[Accel-config] [PATCH 3/3] accel-config: Update manpages to use "read buffer" instead of "token"

Ramesh Thomas <ramesh.thomas at intel.com> Thu, 16 Dec 2021 10:01:14 -0800
Newsgroups dev.linux.lists.accel-config
Message-ID <[email protected]>
Update device and group config commands documentation to refer to read
buffers instead of bw tokens. The short option is kept the same but the
long option is renamed. Update list command example replacing "token"
with "read_buffer".

Signed-off-by: Ramesh Thomas <ramesh.thomas(a)intel.com>
---
 .../accfg/accel-config-config-device.txt      | 10 +++----
 .../accfg/accel-config-config-group.txt       | 26 ++++++++---------
 Documentation/accfg/accel-config-list.txt     | 28 +++++++++----------
 3 files changed, 32 insertions(+), 32 deletions(-)

diff --git a/Documentation/accfg/accel-config-config-device.txt b/Documentation/accfg/accel-config-config-device.txt
index f9a373b..999aca2 100644
--- a/Documentation/accfg/accel-config-config-device.txt
+++ b/Documentation/accfg/accel-config-config-device.txt
@@ -14,16 +14,16 @@ SYNOPSIS
 
 EXAMPLE
 -------
-accel-config config-device dsa0 --token-limit=1
+accel-config config-device dsa0 --read-buffer-limit=1
 
 OPTIONS
 -------
 -l::
---token-limit=::
-	This specifies the maximum number of bandwidth tokens that may be
+--read-buffer-limit=::
+	This specifies the maximum number of read buffers that may be
 	in use at one time by operations that access low bandwidth memory.
-	This number of bandwidth tokens is shared by all descriptors accessing
-	low bandwidth memory across the entire device. token_limit should be
+	This number of read buffers is shared by all descriptors accessing
+	low bandwidth memory across the entire device. read-buffer-limit should be
 	more than 0.
 
 include::../copyright.txt[]
diff --git a/Documentation/accfg/accel-config-config-group.txt b/Documentation/accfg/accel-config-config-group.txt
index c96afb5..1fff1f6 100644
--- a/Documentation/accfg/accel-config-config-group.txt
+++ b/Documentation/accfg/accel-config-config-group.txt
@@ -14,33 +14,33 @@ SYNOPSIS
 
 EXAMPLE
 -------
-accel-config config-group dsa0/group0.0 --tokens-reserved=1
+accel-config config-group dsa0/group0.0 --read-buffers-reserved=1
 
 OPTIONS
 -------
 -r::
---tokens-reserved=::
-	specify the number of badwdith tokens reserved for the use of engines
+--read-buffers-reserved=::
+	specify the number of read buffers reserved for the use of engines
 	in the group. The limit of this value must be:
-	- The sum of all tokens-reserved for all groups must be less than or
-	  equal to total badwidth tokens from group capability field of the
+	- The sum of all read-buffers-reserved for all groups must be less than or
+	  equal to total read buffers from group capability field of the
 	  device.
 
 -t::
---tokens-allowed=::
-	specify the maxinum number of bandwidth tokens that may be in use at
+--read-buffers-allowed=::
+	specify the maxinum number of read buffers that may be in use at
 	one time by all engines in the group. This value can be used to
 	limit the maximum bandwidth used by engines in the group. The limit
 	of this value must be:
 	- greater than 0
-	- greater than or equal to the tokens-reserved value for this group.
-	- less than or equal to the sum of tokens reserved field and the
-	  non-reserved bandwidth tokens (total bandwidth tokens - total
-	  tokens-reserved for all groups).
+	- greater than or equal to the read-buffers-reserved value for this group.
+	- less than or equal to the sum of read-buffers reserved-field and the
+	  non-reserved read buffers (total read buffers - total read buffers
+	  reserved for all groups).
 
 -l::
---use-token-limit=::
-	toggle the enabling of token limt usage. use-token-limit should be
+--use-read-buffer-limit=::
+	toggle the enabling of read-buffer limt usage. use-read-buffer-limit should be
 	either 0 or 1.
 
 -a::
diff --git a/Documentation/accfg/accel-config-list.txt b/Documentation/accfg/accel-config-list.txt
index 37146c1..b7416ea 100644
--- a/Documentation/accfg/accel-config-list.txt
+++ b/Documentation/accfg/accel-config-list.txt
@@ -29,7 +29,7 @@ EXAMPLE
 [
   {
     "dev":"dsa0",
-    "token_limit":0,
+    "read_buffer_limit":0,
     "max_groups":4,
     "max_work_queues":8,
     "max_engines":4,
@@ -37,7 +37,7 @@ EXAMPLE
     "numa_node":-1,
     "op_cap":"0x1003f03ff",
     "state":"enabled",
-    "max_tokens":64,
+    "max_read_buffers":64,
     "max_batch_size":512,
     "ims_size":256,
     "max_transfer_size":2147483648,
@@ -48,9 +48,9 @@ EXAMPLE
     "groups":[
       {
         "dev":"group0.0",
-        "tokens_reserved":0,
-        "use_token_limit":0,
-        "tokens_allowed":0,
+        "read_buffers_reserved":0,
+        "use_read_buffer_limit":0,
+        "read_buffers_allowed":0,
         "traffic_class_a":-1,
         "traffic_class_b":-1,
         "grouped_workqueues":[
@@ -82,9 +82,9 @@ EXAMPLE
       },
       {
         "dev":"group0.1",
-        "tokens_reserved":0,
-        "use_token_limit":0,
-        "tokens_allowed":0,
+        "read_buffers_reserved":0,
+        "use_read_buffer_limit":0,
+        "read_buffers_allowed":0,
         "traffic_class_a":-1,
         "traffic_class_b":-1,
         "grouped_workqueues":[
@@ -116,17 +116,17 @@ EXAMPLE
       },
       {
         "dev":"group0.2",
-        "tokens_reserved":0,
-        "use_token_limit":0,
-        "tokens_allowed":0,
+        "read_buffers_reserved":0,
+        "use_read_buffer_limit":0,
+        "read_buffers_allowed":0,
         "traffic_class_a":-1,
         "traffic_class_b":-1
       },
       {
         "dev":"group0.3",
-        "tokens_reserved":0,
-        "use_token_limit":0,
-        "tokens_allowed":0,
+        "read_buffers_reserved":0,
+        "use_read_buffer_limit":0,
+        "read_buffers_allowed":0,
         "traffic_class_a":-1,
         "traffic_class_b":-1
       }
-- 
2.31.1