[v1,1/1] doc: update to Intel vRAN Boost PMD

Message ID 20230224182019.83342-2-nicolas.chautru@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Maxime Coquelin
Headers
Series doc: PMD update |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Chautru, Nicolas Feb. 24, 2023, 6:20 p.m. UTC
  Cosmetic change to refer explictly to the full name of the PMD
Intel vRAN Boost v1.
VRB1 acronym is only used as a prefix within the code.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/bbdevs/vrb1.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
  

Comments

Maxime Coquelin Feb. 27, 2023, 9:04 a.m. UTC | #1
On 2/24/23 19:20, Nicolas Chautru wrote:
> Cosmetic change to refer explictly to the full name of the PMD
> Intel vRAN Boost v1.
> VRB1 acronym is only used as a prefix within the code.
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> ---
>   doc/guides/bbdevs/vrb1.rst | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/bbdevs/vrb1.rst b/doc/guides/bbdevs/vrb1.rst
> index f5a9dff804..9c48d30964 100644
> --- a/doc/guides/bbdevs/vrb1.rst
> +++ b/doc/guides/bbdevs/vrb1.rst
> @@ -104,7 +104,7 @@ Initialization
>   --------------
>   
>   When the device first powers up, its PCI Physical Functions (PF)
> -can be listed through these commands for VRB1:
> +can be listed through these commands for Intel vRAN Boost v1:
>   
>   .. code-block:: console
>   
> @@ -123,7 +123,7 @@ Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
>   ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
>   
>   The igb_uio driver may be bound to the PF PCI device using one of two methods
> -for VRB1:
> +for Intel vRAN Boost v1:
>   
>   #. PCI functions (physical or virtual, depending on the use case) can be bound
>   to the UIO driver by repeating this command for every function.
> @@ -252,7 +252,7 @@ from the VF and not only limited to the PF as captured above.
>   
>   See for more details: https://github.com/intel/pf-bb-config
>   
> -Specifically for the bbdev VRB1 PMD, the command below can be used
> +Specifically for the bbdev Intel vRAN Boost v1 PMD, the command below can be used
>   (note that ACC200 was used previously to refer to VRB1):
>   
>   .. code-block:: console

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
  
Maxime Coquelin March 6, 2023, 1:21 p.m. UTC | #2
On 2/27/23 10:04, Maxime Coquelin wrote:
> 
> 
> On 2/24/23 19:20, Nicolas Chautru wrote:
>> Cosmetic change to refer explictly to the full name of the PMD

Fixed explictly -> explicitly

>> Intel vRAN Boost v1.
>> VRB1 acronym is only used as a prefix within the code.
>>
>> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
>> ---
>>   doc/guides/bbdevs/vrb1.rst | 6 +++---
>>   1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/doc/guides/bbdevs/vrb1.rst b/doc/guides/bbdevs/vrb1.rst
>> index f5a9dff804..9c48d30964 100644
>> --- a/doc/guides/bbdevs/vrb1.rst
>> +++ b/doc/guides/bbdevs/vrb1.rst
>> @@ -104,7 +104,7 @@ Initialization
>>   --------------
>>   When the device first powers up, its PCI Physical Functions (PF)
>> -can be listed through these commands for VRB1:
>> +can be listed through these commands for Intel vRAN Boost v1:
>>   .. code-block:: console
>> @@ -123,7 +123,7 @@ Install the DPDK igb_uio driver, bind it with the 
>> PF PCI device ID and use
>>   ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK 
>> UIO driver.
>>   The igb_uio driver may be bound to the PF PCI device using one of 
>> two methods
>> -for VRB1:
>> +for Intel vRAN Boost v1:
>>   #. PCI functions (physical or virtual, depending on the use case) 
>> can be bound
>>   to the UIO driver by repeating this command for every function.
>> @@ -252,7 +252,7 @@ from the VF and not only limited to the PF as 
>> captured above.
>>   See for more details: https://github.com/intel/pf-bb-config
>> -Specifically for the bbdev VRB1 PMD, the command below can be used
>> +Specifically for the bbdev Intel vRAN Boost v1 PMD, the command below 
>> can be used
>>   (note that ACC200 was used previously to refer to VRB1):
>>   .. code-block:: console
> 
> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> 
> Thanks,
> Maxime


Applied to dpdk-next-baseband/for-main.

Thanks,
Maxime
  

Patch

diff --git a/doc/guides/bbdevs/vrb1.rst b/doc/guides/bbdevs/vrb1.rst
index f5a9dff804..9c48d30964 100644
--- a/doc/guides/bbdevs/vrb1.rst
+++ b/doc/guides/bbdevs/vrb1.rst
@@ -104,7 +104,7 @@  Initialization
 --------------
 
 When the device first powers up, its PCI Physical Functions (PF)
-can be listed through these commands for VRB1:
+can be listed through these commands for Intel vRAN Boost v1:
 
 .. code-block:: console
 
@@ -123,7 +123,7 @@  Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
 ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
 
 The igb_uio driver may be bound to the PF PCI device using one of two methods
-for VRB1:
+for Intel vRAN Boost v1:
 
 #. PCI functions (physical or virtual, depending on the use case) can be bound
 to the UIO driver by repeating this command for every function.
@@ -252,7 +252,7 @@  from the VF and not only limited to the PF as captured above.
 
 See for more details: https://github.com/intel/pf-bb-config
 
-Specifically for the bbdev VRB1 PMD, the command below can be used
+Specifically for the bbdev Intel vRAN Boost v1 PMD, the command below can be used
 (note that ACC200 was used previously to refer to VRB1):
 
 .. code-block:: console