netdev - [net-next 11/13] Documentation: ice: Prepare documentation for RST conversion

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20181018203259.4175-12-jeffrey.t.kirsher@intel.com>
Date:   Thu, 18 Oct 2018 13:32:57 -0700
From:   Jeff Kirsher <jeffrey.t.kirsher@...el.com>
To:     davem@...emloft.net
Cc:     Jeff Kirsher <jeffrey.t.kirsher@...el.com>, netdev@...r.kernel.org,
        nhorman@...hat.com, sassmann@...hat.com
Subject: [net-next 11/13] Documentation: ice: Prepare documentation for RST conversion

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@...el.com>
Tested-by: Andrew Bowers <andrewx.bowers@...el.com>
Tested-by: Aaron Brown <aaron.f.brown@...el.com>
---
 Documentation/networking/ice.txt | 34 +++++++++++++++++++-------------
 1 file changed, 20 insertions(+), 14 deletions(-)

diff --git a/Documentation/networking/ice.txt b/Documentation/networking/ice.txt
index 6261c46378e1..1e4948c9e989 100644
--- a/Documentation/networking/ice.txt
+++ b/Documentation/networking/ice.txt
@@ -1,4 +1,6 @@
-Intel(R) Ethernet Connection E800 Series Linux Driver
+.. SPDX-License-Identifier: GPL-2.0+
+
+Linux* Base Driver for the Intel(R) Ethernet Connection E800 Series
 ===================================================================
 
 Intel ice Linux driver.
@@ -6,34 +8,38 @@ Copyright(c) 2018 Intel Corporation.
 
 Contents
 ========
+
 - Enabling the driver
 - Support
 
 The driver in this release supports Intel's E800 Series of products. For
-more information, visit Intel's support page at http://support.intel.com.
+more information, visit Intel's support page at https://support.intel.com.
 
 Enabling the driver
 ===================
-
 The driver is enabled via the standard kernel configuration system,
-using the make command:
+using the make command::
 
-     Make oldconfig/silentoldconfig/menuconfig/etc.
+  make oldconfig/silentoldconfig/menuconfig/etc.
 
 The driver is located in the menu structure at:
 
-	-> Device Drivers
-	  -> Network device support (NETDEVICES [=y])
-	    -> Ethernet driver support
-	      -> Intel devices
-	        -> Intel(R) Ethernet Connection E800 Series Support
+  -> Device Drivers
+    -> Network device support (NETDEVICES [=y])
+      -> Ethernet driver support
+        -> Intel devices
+          -> Intel(R) Ethernet Connection E800 Series Support
 
 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:
+
+https://sourceforge.net/projects/e1000
 
-If an issue is identified with the released source code, please email
-the maintainer listed in the MAINTAINERS file.
+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@...ts.sf.net.
-- 
2.17.2