Netdev List
 help / color / mirror / Atom feed
From: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
To: davem@davemloft.net
Cc: Jeff Kirsher <jeffrey.t.kirsher@intel.com>,
	netdev@vger.kernel.org, nhorman@redhat.com, sassmann@redhat.com
Subject: [net-next 06/13] Documentation: igbvf: Prepare documentation for RST conversion
Date: Thu, 18 Oct 2018 13:32:52 -0700	[thread overview]
Message-ID: <20181018203259.4175-7-jeffrey.t.kirsher@intel.com> (raw)
In-Reply-To: <20181018203259.4175-1-jeffrey.t.kirsher@intel.com>

Before making the conversion to the RST (reStructured Text) format, there
are changes needed to the documentation so that there are no build errors.

Also fixed old/broken URLs to the correct or updated URL.

Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Tested-by: Andrew Bowers <andrewx.bowers@intel.com>
Tested-by: Aaron Brown <aaron.f.brown@intel.com>
---
 Documentation/networking/igbvf.txt | 82 ++++++++++++------------------
 1 file changed, 33 insertions(+), 49 deletions(-)

diff --git a/Documentation/networking/igbvf.txt b/Documentation/networking/igbvf.txt
index bd404735fb46..a8a9ffa4f8d3 100644
--- a/Documentation/networking/igbvf.txt
+++ b/Documentation/networking/igbvf.txt
@@ -1,80 +1,64 @@
-Linux* Base Driver for Intel(R) Ethernet Network Connection
-===========================================================
+.. SPDX-License-Identifier: GPL-2.0+
 
-Intel Gigabit Linux driver.
-Copyright(c) 1999 - 2013 Intel Corporation.
+Linux* Base Virtual Function Driver for Intel(R) 1G Ethernet
+============================================================
+
+Intel Gigabit Virtual Function Linux driver.
+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 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 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.
+SR-IOV requires the correct platform and OS support.
 
-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.
+The guest OS loading this driver must support MSI-X interrupts.
 
-The guest OS loading the igbvf driver must support MSI-X interrupts.
+For questions related to hardware requirements, refer to the documentation
+supplied with your Intel 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 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.
+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.
 
-Instructions on updating ethtool can be found in the section "Additional
-Configurations" later in this document.
+NOTE: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
 
-VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
 
 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
 
-The igbvf driver supports 82576-based virtual function devices that can only
-be activated on kernels that support SR-IOV.
-
-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
+Additional Features and Configurations
+======================================
 
-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:
+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://downloadcenter.intel.com/scripts-df-external/Support_Intel.aspx
+https://www.kernel.org/pub/software/network/ethtool/
 
-Additional 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:
-
-  https://www.kernel.org/pub/software/network/ethtool/
 
 Support
 =======
-
 For general information, go to the Intel support website at:
 
-    http://support.intel.com
+https://www.intel.com/support/
 
 or the Intel Wired Networking project hosted by Sourceforge at:
 
-    http://sourceforge.net/projects/e1000
+https://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
+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.
-- 
2.17.2

  parent reply	other threads:[~2018-10-19  4:35 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-18 20:32 [net-next 00/13][pull request] Intel Wired LAN Doc Updates 2018-10-18 Jeff Kirsher
2018-10-18 20:32 ` [net-next 01/13] Documentation: networking: ixgb: Remove reference to IXGB_NAPI Jeff Kirsher
2018-10-18 20:32 ` [net-next 02/13] Documentation: e100, e1000: Add missing SPDX header Jeff Kirsher
2018-10-18 20:32 ` [net-next 03/13] Documentation: ixgb: Prepare documentation for RST conversion Jeff Kirsher
2018-10-18 20:32 ` [net-next 04/13] Documentation: e1000e: " Jeff Kirsher
2018-10-18 20:32 ` [net-next 05/13] Documentation: igb: " Jeff Kirsher
2018-10-18 20:32 ` Jeff Kirsher [this message]
2018-10-18 20:32 ` [net-next 07/13] Documentation: ixgbe: " Jeff Kirsher
2018-10-18 20:32 ` [net-next 08/13] Documentation: ixgbevf: " Jeff Kirsher
2018-10-18 20:32 ` [net-next 09/13] Documentation: i40e: " Jeff Kirsher
2018-10-18 20:32 ` [net-next 10/13] Documentation: iavf: " Jeff Kirsher
2018-10-18 20:32 ` [net-next 11/13] Documentation: ice: " Jeff Kirsher
2018-10-18 20:32 ` [net-next 12/13] Documentation: fm10k: Add kernel documentation Jeff Kirsher
2018-10-18 20:32 ` [net-next 13/13] Documentation: intel: Convert to RST format Jeff Kirsher
2018-10-18 22:46 ` [net-next 00/13][pull request] Intel Wired LAN Doc Updates 2018-10-18 David Miller

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=20181018203259.4175-7-jeffrey.t.kirsher@intel.com \
    --to=jeffrey.t.kirsher@intel.com \
    --cc=davem@davemloft.net \
    --cc=netdev@vger.kernel.org \
    --cc=nhorman@redhat.com \
    --cc=sassmann@redhat.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