[v2] Documentation: igbvf: Update kernel documentation

Message ID 20180412215823.24727-1-jeffrey.t.kirsher@intel.com
State Changes Requested
Delegated to: Jeff Kirsher
Headers show
Series
  • [v2] Documentation: igbvf: Update kernel documentation
Related show

Commit Message

Jeff Kirsher April 12, 2018, 9:58 p.m.
Updated the igbvf.txt kernel documentation with the latest information.

Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
---
v2: fixed up documentation based on community feedback and internal
    review

---
 Documentation/networking/igbvf.txt | 86 ++++++++++++++++----------------------
 1 file changed, 36 insertions(+), 50 deletions(-)

Comments

Shannon Nelson April 13, 2018, 3:31 p.m. | #1
On 4/12/2018 2:58 PM, Jeff Kirsher wrote:
> Updated the igbvf.txt kernel documentation with the latest information.
> 
> Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> ---
> v2: fixed up documentation based on community feedback and internal
>      review
> 
> ---
>   Documentation/networking/igbvf.txt | 86 ++++++++++++++++----------------------
>   1 file changed, 36 insertions(+), 50 deletions(-)
> 
> diff --git a/Documentation/networking/igbvf.txt b/Documentation/networking/igbvf.txt
> index bd404735fb46..e2d54a8a567d 100644
> --- a/Documentation/networking/igbvf.txt
> +++ b/Documentation/networking/igbvf.txt
> @@ -2,79 +2,65 @@ Linux* Base Driver for Intel(R) Ethernet Network Connection
>   ===========================================================
>   
>   Intel Gigabit Linux driver.
> -Copyright(c) 1999 - 2013 Intel Corporation.
> +Copyright(c) 1999-2018 Intel Corporation.
>   
>   Contents
>   ========
> -
>   - Identifying Your Adapter
>   - Additional Configurations
>   - Support
>   
> -This file describes the igbvf Linux* Base Driver for Intel Network Connection.
> +This virtual function driver supports kernel versions 2.6.x and newer.

No, it only supports the Linux kernel that it is in, this is not the 
out-of-tree driver.

sln

>   
> -The igbvf driver supports 82576-based virtual function devices that can only
> -be activated on kernels that support SR-IOV. SR-IOV requires the correct
> -platform and OS support.
> +This driver supports Intel 82576-based virtual function devices-based virtual
> +function devices
> +that can only be activated on kernels that support SR-IOV.
>   
> -The igbvf driver requires the igb driver, version 2.0 or later. The igbvf
> -driver supports virtual functions generated by the igb driver with a max_vfs
> -value of 1 or greater. For more information on the max_vfs parameter refer
> -to the README included with the igb driver.
> +SR-IOV requires the correct platform and OS support.
>   
> -The guest OS loading the igbvf driver must support MSI-X interrupts.
> +The guest OS loading this driver must support MSI-X interrupts.
>   
> -This driver is only supported as a loadable module at this time.  Intel is
> -not supplying patches against the kernel source to allow for static linking
> -of the driver.  For questions related to hardware requirements, refer to the
> -documentation supplied with your Intel Gigabit adapter.  All hardware
> -requirements listed apply to use with Linux.
> +This driver is only supported as a loadable module at this time. Intel is not
> +supplying patches against the kernel source to allow for static linking of the
> +drivers.
>   
> -Instructions on updating ethtool can be found in the section "Additional
> -Configurations" later in this document.
> +For questions related to hardware requirements, refer to the documentation
> +supplied with your Intel adapter. All hardware requirements listed apply to use
> +with Linux.
>   
> -VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
> +Driver information can be obtained using ethtool, lspci, and ifconfig.
> +Instructions on updating ethtool can be found in the section Additional
> +Configurations later in this document.
>   
> -Identifying Your Adapter
> -========================
> -
> -The igbvf driver supports 82576-based virtual function devices that can only
> -be activated on kernels that support SR-IOV.
> +VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
>   
> -For more information on how to identify your adapter, go to the Adapter &
> -Driver ID Guide at:
>   
> -    http://support.intel.com/support/go/network/adapter/idguide.htm
>   
> -For the latest Intel network drivers for Linux, refer to the following
> -website.  In the search field, enter your adapter name or type, or use the
> -networking link on the left to search for your adapter:
> +Identifying Your Adapter
> +------------------------
> +For information on how to identify your adapter, and for the latest Intel
> +network drivers, refer to the Intel Support website:
> +http://www.intel.com/support
>   
> -    http://downloadcenter.intel.com/scripts-df-external/Support_Intel.aspx
>   
> -Additional Configurations
> -=========================
> +Additional Features and Configurations
> +-------------------------------------------
>   
> -  ethtool
> -  -------
> -  The driver utilizes the ethtool interface for driver configuration and
> -  diagnostics, as well as displaying statistical information.  The ethtool
> -  version 3.0 or later is required for this functionality, although we
> -  strongly recommend downloading the latest version at:
> +ethtool
> +-------
> +The driver utilizes the ethtool interface for driver configuration and
> +diagnostics, as well as displaying statistical information. The latest ethtool
> +version is required for this functionality. Download it at:
> +http://ftp.kernel.org/pub/software/network/ethtool/
>   
> -  https://www.kernel.org/pub/software/network/ethtool/
>   
>   Support
> -=======
> -
> +-------
>   For general information, go to the Intel support website at:
> -
> -    http://support.intel.com
> +http://www.intel.com/support/
>   
>   or the Intel Wired Networking project hosted by Sourceforge at:
> -
> -    http://sourceforge.net/projects/e1000
> -
> -If an issue is identified with the released source code on the supported
> -kernel with a supported adapter, email the specific information related
> -to the issue to e1000-devel@lists.sf.net
> +http://sourceforge.net/projects/e1000
> +If an issue is identified with the released source code on a supported kernel
> +with a supported adapter, email the specific information related to the issue
> +to e1000-devel@lists.sf.net.
>
Brown, Aaron F April 24, 2018, 12:49 a.m. | #2
> -----Original Message-----
> From: Intel-wired-lan [mailto:intel-wired-lan-bounces@osuosl.org] On
> Behalf Of Shannon Nelson
> Sent: Friday, April 13, 2018 8:32 AM
> To: intel-wired-lan@osuosl.org
> Subject: Re: [Intel-wired-lan] [PATCH v2] Documentation: igbvf: Update
> kernel documentation
> 
> On 4/12/2018 2:58 PM, Jeff Kirsher wrote:
> > Updated the igbvf.txt kernel documentation with the latest information.
> >
> > Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> > ---
> > v2: fixed up documentation based on community feedback and internal
> >      review
> >
> > ---
> >   Documentation/networking/igbvf.txt | 86 ++++++++++++++++-------------
> ---------
> >   1 file changed, 36 insertions(+), 50 deletions(-)
> >
> > diff --git a/Documentation/networking/igbvf.txt
> b/Documentation/networking/igbvf.txt
> > index bd404735fb46..e2d54a8a567d 100644
> > --- a/Documentation/networking/igbvf.txt
> > +++ b/Documentation/networking/igbvf.txt
> > @@ -2,79 +2,65 @@ Linux* Base Driver for Intel(R) Ethernet Network
> Connection
> >
> ==========================================================
> =
> >
> >   Intel Gigabit Linux driver.
> > -Copyright(c) 1999 - 2013 Intel Corporation.
> > +Copyright(c) 1999-2018 Intel Corporation.
> >
> >   Contents
> >   ========
> > -
> >   - Identifying Your Adapter
> >   - Additional Configurations
> >   - Support
> >
> > -This file describes the igbvf Linux* Base Driver for Intel Network
> Connection.
> > +This virtual function driver supports kernel versions 2.6.x and newer.
> 
> No, it only supports the Linux kernel that it is in, this is not the
> out-of-tree driver.
> 
> sln

True.  It makes little sense for the kernel driver documentation to specify anything but itself.

> 
> >
> > -The igbvf driver supports 82576-based virtual function devices that can
> only
> > -be activated on kernels that support SR-IOV. SR-IOV requires the correct
> > -platform and OS support.
> > +This driver supports Intel 82576-based virtual function devices-based
> virtual
> > +function devices
> > +that can only be activated on kernels that support SR-IOV.

This seems to break formatting.  A new line follows "function devices" making a 2 word line with the sentence, "that can only be activated...", finishing on the following line.

> >
> > -The igbvf driver requires the igb driver, version 2.0 or later. The igbvf
> > -driver supports virtual functions generated by the igb driver with a
> max_vfs
> > -value of 1 or greater. For more information on the max_vfs parameter
> refer
> > -to the README included with the igb driver.
> > +SR-IOV requires the correct platform and OS support.
> >
> > -The guest OS loading the igbvf driver must support MSI-X interrupts.
> > +The guest OS loading this driver must support MSI-X interrupts.
> >
> > -This driver is only supported as a loadable module at this time.  Intel is
> > -not supplying patches against the kernel source to allow for static linking
> > -of the driver.  For questions related to hardware requirements, refer to
> the
> > -documentation supplied with your Intel Gigabit adapter.  All hardware
> > -requirements listed apply to use with Linux.
> > +This driver is only supported as a loadable module at this time. Intel is not
> > +supplying patches against the kernel source to allow for static linking of
> the
> > +drivers.

Should this even be included for the in kernel module?  The kernel driver does compile and function as a built in driver as well as a module.

> >
> > -Instructions on updating ethtool can be found in the section "Additional
> > -Configurations" later in this document.
> > +For questions related to hardware requirements, refer to the
> documentation
> > +supplied with your Intel adapter. All hardware requirements listed apply
> to use
> > +with Linux.
> >
> > -VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
> > +Driver information can be obtained using ethtool, lspci, and ifconfig.
> > +Instructions on updating ethtool can be found in the section Additional
> > +Configurations later in this document.
> >
> > -Identifying Your Adapter
> > -========================
> > -
> > -The igbvf driver supports 82576-based virtual function devices that can
> only
> > -be activated on kernels that support SR-IOV.
> > +VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
> >
> > -For more information on how to identify your adapter, go to the Adapter
> &
> > -Driver ID Guide at:
> >
> > -    http://support.intel.com/support/go/network/adapter/idguide.htm
> >
> > -For the latest Intel network drivers for Linux, refer to the following
> > -website.  In the search field, enter your adapter name or type, or use the
> > -networking link on the left to search for your adapter:
> > +Identifying Your Adapter
> > +------------------------
> > +For information on how to identify your adapter, and for the latest Intel
> > +network drivers, refer to the Intel Support website:
> > +http://www.intel.com/support
> >
> > -    http://downloadcenter.intel.com/scripts-df-
> external/Support_Intel.aspx
> >
> > -Additional Configurations
> > -=========================
> > +Additional Features and Configurations
> > +-------------------------------------------
> >
> > -  ethtool
> > -  -------
> > -  The driver utilizes the ethtool interface for driver configuration and
> > -  diagnostics, as well as displaying statistical information.  The ethtool
> > -  version 3.0 or later is required for this functionality, although we
> > -  strongly recommend downloading the latest version at:
> > +ethtool
> > +-------
> > +The driver utilizes the ethtool interface for driver configuration and
> > +diagnostics, as well as displaying statistical information. The latest ethtool
> > +version is required for this functionality. Download it at:
> > +http://ftp.kernel.org/pub/software/network/ethtool/
> >
> > -  https://www.kernel.org/pub/software/network/ethtool/

I am currently not able to resolve ftp.kernel.org, the new URL, but have no trouble with https://www.kernel.org, e.g. the removed URL.

> >
> >   Support
> > -=======
> > -
> > +-------
> >   For general information, go to the Intel support website at:
> > -
> > -    http://support.intel.com
> > +http://www.intel.com/support/
> >
> >   or the Intel Wired Networking project hosted by Sourceforge at:
> > -
> > -    http://sourceforge.net/projects/e1000
> > -
> > -If an issue is identified with the released source code on the supported
> > -kernel with a supported adapter, email the specific information related
> > -to the issue to e1000-devel@lists.sf.net
> > +http://sourceforge.net/projects/e1000
> > +If an issue is identified with the released source code on a supported
> kernel
> > +with a supported adapter, email the specific information related to the
> issue
> > +to e1000-devel@lists.sf.net.
> >
> _______________________________________________
> Intel-wired-lan mailing list
> Intel-wired-lan@osuosl.org
> https://lists.osuosl.org/mailman/listinfo/intel-wired-lan

Patch

diff --git a/Documentation/networking/igbvf.txt b/Documentation/networking/igbvf.txt
index bd404735fb46..e2d54a8a567d 100644
--- a/Documentation/networking/igbvf.txt
+++ b/Documentation/networking/igbvf.txt
@@ -2,79 +2,65 @@  Linux* Base Driver for Intel(R) Ethernet Network Connection
 ===========================================================
 
 Intel Gigabit Linux driver.
-Copyright(c) 1999 - 2013 Intel Corporation.
+Copyright(c) 1999-2018 Intel Corporation.
 
 Contents
 ========
-
 - Identifying Your Adapter
 - Additional Configurations
 - Support
 
-This file describes the igbvf Linux* Base Driver for Intel Network Connection.
+This virtual function driver supports kernel versions 2.6.x and newer.
 
-The igbvf driver supports 82576-based virtual function devices that can only
-be activated on kernels that support SR-IOV. SR-IOV requires the correct
-platform and OS support.
+This driver supports Intel 82576-based virtual function devices-based virtual
+function devices
+that can only be activated on kernels that support SR-IOV.
 
-The igbvf driver requires the igb driver, version 2.0 or later. The igbvf
-driver supports virtual functions generated by the igb driver with a max_vfs
-value of 1 or greater. For more information on the max_vfs parameter refer
-to the README included with the igb driver.
+SR-IOV requires the correct platform and OS support.
 
-The guest OS loading the igbvf driver must support MSI-X interrupts.
+The guest OS loading this driver must support MSI-X interrupts.
 
-This driver is only supported as a loadable module at this time.  Intel is
-not supplying patches against the kernel source to allow for static linking
-of the driver.  For questions related to hardware requirements, refer to the
-documentation supplied with your Intel Gigabit adapter.  All hardware
-requirements listed apply to use with Linux.
+This driver is only supported as a loadable module at this time. Intel is not
+supplying patches against the kernel source to allow for static linking of the
+drivers.
 
-Instructions on updating ethtool can be found in the section "Additional
-Configurations" later in this document.
+For questions related to hardware requirements, refer to the documentation
+supplied with your Intel adapter. All hardware requirements listed apply to use
+with Linux.
 
-VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
+Driver information can be obtained using ethtool, lspci, and ifconfig.
+Instructions on updating ethtool can be found in the section Additional
+Configurations later in this document.
 
-Identifying Your Adapter
-========================
-
-The igbvf driver supports 82576-based virtual function devices that can only
-be activated on kernels that support SR-IOV.
+VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
 
-For more information on how to identify your adapter, go to the Adapter &
-Driver ID Guide at:
 
-    http://support.intel.com/support/go/network/adapter/idguide.htm
 
-For the latest Intel network drivers for Linux, refer to the following
-website.  In the search field, enter your adapter name or type, or use the
-networking link on the left to search for your adapter:
+Identifying Your Adapter
+------------------------
+For information on how to identify your adapter, and for the latest Intel
+network drivers, refer to the Intel Support website:
+http://www.intel.com/support
 
-    http://downloadcenter.intel.com/scripts-df-external/Support_Intel.aspx
 
-Additional Configurations
-=========================
+Additional Features and Configurations
+-------------------------------------------
 
-  ethtool
-  -------
-  The driver utilizes the ethtool interface for driver configuration and
-  diagnostics, as well as displaying statistical information.  The ethtool
-  version 3.0 or later is required for this functionality, although we
-  strongly recommend downloading the latest version at:
+ethtool
+-------
+The driver utilizes the ethtool interface for driver configuration and
+diagnostics, as well as displaying statistical information. The latest ethtool
+version is required for this functionality. Download it at:
+http://ftp.kernel.org/pub/software/network/ethtool/
 
-  https://www.kernel.org/pub/software/network/ethtool/
 
 Support
-=======
-
+-------
 For general information, go to the Intel support website at:
-
-    http://support.intel.com
+http://www.intel.com/support/
 
 or the Intel Wired Networking project hosted by Sourceforge at:
-
-    http://sourceforge.net/projects/e1000
-
-If an issue is identified with the released source code on the supported
-kernel with a supported adapter, email the specific information related
-to the issue to e1000-devel@lists.sf.net
+http://sourceforge.net/projects/e1000
+If an issue is identified with the released source code on a supported kernel
+with a supported adapter, email the specific information related to the issue
+to e1000-devel@lists.sf.net.