[2/2] doc: rename avf to iavf

Message ID 20190222150336.22299-2-leyi.rong@intel.com
State Superseded, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • [1/2] net/iavf: rename avf to iavf
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/checkpatch success coding style OK

Commit Message

Leyi Rong Feb. 22, 2019, 3:03 p.m.
This patch renames avf to iavf only for the doc files.

Signed-off-by: Leyi Rong <leyi.rong@intel.com>
---
 MAINTAINERS                                        |  6 +++---
 doc/guides/nics/features/{avf.ini => iavf.ini}     |  2 +-
 .../nics/features/{avf_vec.ini => iavf_vec.ini}    |  2 +-
 doc/guides/nics/intel_vf.rst                       | 14 +++++++-------
 4 files changed, 12 insertions(+), 12 deletions(-)
 rename doc/guides/nics/features/{avf.ini => iavf.ini} (93%)
 rename doc/guides/nics/features/{avf_vec.ini => iavf_vec.ini} (92%)

Comments

Ferruh Yigit Feb. 22, 2019, 4:46 p.m. | #1
On 2/22/2019 3:03 PM, Leyi Rong wrote:
> This patch renames avf to iavf only for the doc files.
> 
> Signed-off-by: Leyi Rong <leyi.rong@intel.com>
> ---
>  MAINTAINERS                                        |  6 +++---
>  doc/guides/nics/features/{avf.ini => iavf.ini}     |  2 +-
>  .../nics/features/{avf_vec.ini => iavf_vec.ini}    |  2 +-
>  doc/guides/nics/intel_vf.rst                       | 14 +++++++-------
>  4 files changed, 12 insertions(+), 12 deletions(-)
>  rename doc/guides/nics/features/{avf.ini => iavf.ini} (93%)
>  rename doc/guides/nics/features/{avf_vec.ini => iavf_vec.ini} (92%)

Normally I believe no need to make this a separate patch, but perhaps can be OK
to separate since first one is too big.

If the suggestion I make to separate renaming files, and updating file content
makes those patches smaller, I suggest squashing this patch that one.
Leyi Rong Feb. 24, 2019, 8:51 a.m. | #2
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Saturday, February 23, 2019 12:46 AM
> To: Rong, Leyi <leyi.rong@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>; Lu, Wenzhuo <wenzhuo.lu@intel.com>;
> Zhang, Qi Z <qi.z.zhang@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH 2/2] doc: rename avf to iavf
> 
> On 2/22/2019 3:03 PM, Leyi Rong wrote:
> > This patch renames avf to iavf only for the doc files.
> >
> > Signed-off-by: Leyi Rong <leyi.rong@intel.com>
> > ---
> >  MAINTAINERS                                        |  6 +++---
> >  doc/guides/nics/features/{avf.ini => iavf.ini}     |  2 +-
> >  .../nics/features/{avf_vec.ini => iavf_vec.ini}    |  2 +-
> >  doc/guides/nics/intel_vf.rst                       | 14 +++++++-------
> >  4 files changed, 12 insertions(+), 12 deletions(-)  rename
> > doc/guides/nics/features/{avf.ini => iavf.ini} (93%)  rename
> > doc/guides/nics/features/{avf_vec.ini => iavf_vec.ini} (92%)
> 
> Normally I believe no need to make this a separate patch, but perhaps can be OK to separate since first one is too big.
> 
> If the suggestion I make to separate renaming files, and updating file content makes those patches smaller, I suggest
> squashing this patch that one.

Hi Ferruh,

Can I just keep this patch as a separate one since this one will only affect the doc files, but the previous patch is a big one which will affect the iavf src code.

Thanks,
Leyi

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index eef480ab5..d0d7bb21a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -577,12 +577,12 @@  F: drivers/net/fm10k/
 F: doc/guides/nics/fm10k.rst
 F: doc/guides/nics/features/fm10k*.ini
 
-Intel avf
+Intel iavf
 M: Jingjing Wu <jingjing.wu@intel.com>
 M: Wenzhuo Lu <wenzhuo.lu@intel.com>
 T: git://dpdk.org/next/dpdk-next-net-intel
-F: drivers/net/avf/
-F: doc/guides/nics/features/avf*.ini
+F: drivers/net/iavf/
+F: doc/guides/nics/features/iavf*.ini
 
 Intel ifc
 M: Xiao Wang <xiao.w.wang@intel.com>
diff --git a/doc/guides/nics/features/avf.ini b/doc/guides/nics/features/iavf.ini
similarity index 93%
rename from doc/guides/nics/features/avf.ini
rename to doc/guides/nics/features/iavf.ini
index 35ceada24..80143059e 100644
--- a/doc/guides/nics/features/avf.ini
+++ b/doc/guides/nics/features/iavf.ini
@@ -1,5 +1,5 @@ 
 ;
-; Supported features of the 'avf' network poll mode driver.
+; Supported features of the 'iavf' network poll mode driver.
 ;
 ; Refer to default.ini for the full list of available PMD features.
 ;
diff --git a/doc/guides/nics/features/avf_vec.ini b/doc/guides/nics/features/iavf_vec.ini
similarity index 92%
rename from doc/guides/nics/features/avf_vec.ini
rename to doc/guides/nics/features/iavf_vec.ini
index 3050bc4a6..167f5fdf3 100644
--- a/doc/guides/nics/features/avf_vec.ini
+++ b/doc/guides/nics/features/iavf_vec.ini
@@ -1,5 +1,5 @@ 
 ;
-; Supported features of the 'avf_vec' network poll mode driver.
+; Supported features of the 'iavf_vec' network poll mode driver.
 ;
 ; Refer to default.ini for the full list of available PMD features.
 ;
diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst
index 49a7085a9..e8d5118a0 100644
--- a/doc/guides/nics/intel_vf.rst
+++ b/doc/guides/nics/intel_vf.rst
@@ -68,11 +68,11 @@  which is called a "Mailbox".
 
 Intel® Ethernet Adaptive Virtual Function
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Adaptive Virtual Function (AVF) is a SR-IOV Virtual Function with the same device id (8086:1889) on different Intel Ethernet Controller.
-AVF Driver is VF driver which supports for all future Intel devices without requiring a VM update. And since this happens to be an adaptive VF driver,
+Adaptive Virtual Function (IAVF) is a SR-IOV Virtual Function with the same device id (8086:1889) on different Intel Ethernet Controller.
+IAVF Driver is VF driver which supports for all future Intel devices without requiring a VM update. And since this happens to be an adaptive VF driver,
 every new drop of the VF driver would add more and more advanced features that can be turned on in the VM if the underlying HW device supports those
-advanced features based on a device agnostic way without ever compromising on the base functionality. AVF provides generic hardware interface and
-interface between AVF driver and a compliant PF driver is specified.
+advanced features based on a device agnostic way without ever compromising on the base functionality. IAVF provides generic hardware interface and
+interface between IAVF driver and a compliant PF driver is specified.
 
 Intel products starting Ethernet Controller 700 Series to support Adaptive Virtual Function.
 
@@ -80,12 +80,12 @@  The way to generate Virtual Function is like normal, and the resource of VF assi
 
 For more detail on SR-IOV, please refer to the following documents:
 
-*   `Intel® AVF HAS <https://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/ethernet-adaptive-virtual-function-hardware-spec.pdf>`_
+*   `Intel® IAVF HAS <https://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/ethernet-adaptive-virtual-function-hardware-spec.pdf>`_
 
 .. note::
 
-    To use DPDK AVF PMD on Intel® 700 Series Ethernet Controller, the device id (0x1889) need to specified during device
-    assignment in hypervisor. Take qemu for example, the device assignment should carry the AVF device id (0x1889) like
+    To use DPDK IAVF PMD on Intel® 700 Series Ethernet Controller, the device id (0x1889) need to specified during device
+    assignment in hypervisor. Take qemu for example, the device assignment should carry the IAVF device id (0x1889) like
     ``-device vfio-pci,x-pci-device-id=0x1889,host=03:0a.0``.
 
 The PCIE host-interface of Intel Ethernet Switch FM10000 Series VF infrastructure