mbox series

[net-next,00/13,pull,request] Intel Wired LAN Doc Updates 2018-10-18

Message ID 20181018203259.4175-1-jeffrey.t.kirsher@intel.com
Headers show
Series Intel Wired LAN Doc Updates 2018-10-18 | expand

Message

Kirsher, Jeffrey T Oct. 18, 2018, 8:32 p.m. UTC
This series contains documentation fixes and updates for Intel wired LAN
drivers.

The following was done:
 - Updated incorrect URLs
 - removed document references which did not apply to the current
   in-kernel drivers
 - added documentation for fm10k driver
 - added missing documentation on existing or new features
 - added SPDX headers to all the documentation files

Lastly, the documentation was converted over to the RST (reStructured
Text) format, so that 'make htmldocs' produces pretty html driver
documentation for our drivers.

The following are changes since commit 3a3295bfa6f484bba91de0a804c1d0bf7d31dbd3:
  Merge branch 'sctp-fix-sk_wmem_queued-and-use-it-to-check-for-writable-space'
and are available in the git repository at:
  git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next-queue 10GbE

Corentin Labbe (1):
  Documentation: networking: ixgb: Remove reference to IXGB_NAPI

Jeff Kirsher (12):
  Documentation: e100, e1000: Add missing SPDX header
  Documentation: ixgb: Prepare documentation for RST conversion
  Documentation: e1000e: Prepare documentation for RST conversion
  Documentation: igb: Prepare documentation for RST conversion
  Documentation: igbvf: Prepare documentation for RST conversion
  Documentation: ixgbe: Prepare documentation for RST conversion
  Documentation: ixgbevf: Prepare documentation for RST conversion
  Documentation: i40e: Prepare documentation for RST conversion
  Documentation: iavf: Prepare documentation for RST conversion
  Documentation: ice: Prepare documentation for RST conversion
  Documentation: fm10k: Add kernel documentation
  Documentation: intel: Convert to RST format

 Documentation/networking/00-INDEX    |  20 -
 Documentation/networking/e100.rst    |   3 +-
 Documentation/networking/e1000.rst   |   3 +-
 Documentation/networking/e1000e.rst  | 382 +++++++++++++
 Documentation/networking/e1000e.txt  | 312 -----------
 Documentation/networking/fm10k.rst   | 141 +++++
 Documentation/networking/i40e.rst    | 770 +++++++++++++++++++++++++++
 Documentation/networking/i40e.txt    | 190 -------
 Documentation/networking/iavf.rst    | 281 ++++++++++
 Documentation/networking/iavf.txt    |  56 --
 Documentation/networking/ice.rst     |  45 ++
 Documentation/networking/ice.txt     |  39 --
 Documentation/networking/igb.rst     | 193 +++++++
 Documentation/networking/igb.txt     | 129 -----
 Documentation/networking/igbvf.rst   |  64 +++
 Documentation/networking/igbvf.txt   |  80 ---
 Documentation/networking/index.rst   |  10 +
 Documentation/networking/ixgb.rst    | 467 ++++++++++++++++
 Documentation/networking/ixgb.txt    | 433 ---------------
 Documentation/networking/ixgbe.rst   | 527 ++++++++++++++++++
 Documentation/networking/ixgbe.txt   | 349 ------------
 Documentation/networking/ixgbevf.rst |  66 +++
 Documentation/networking/ixgbevf.txt |  52 --
 MAINTAINERS                          |  19 +-
 drivers/net/ethernet/intel/Kconfig   |  26 +-
 25 files changed, 2982 insertions(+), 1675 deletions(-)
 create mode 100644 Documentation/networking/e1000e.rst
 delete mode 100644 Documentation/networking/e1000e.txt
 create mode 100644 Documentation/networking/fm10k.rst
 create mode 100644 Documentation/networking/i40e.rst
 delete mode 100644 Documentation/networking/i40e.txt
 create mode 100644 Documentation/networking/iavf.rst
 delete mode 100644 Documentation/networking/iavf.txt
 create mode 100644 Documentation/networking/ice.rst
 delete mode 100644 Documentation/networking/ice.txt
 create mode 100644 Documentation/networking/igb.rst
 delete mode 100644 Documentation/networking/igb.txt
 create mode 100644 Documentation/networking/igbvf.rst
 delete mode 100644 Documentation/networking/igbvf.txt
 create mode 100644 Documentation/networking/ixgb.rst
 delete mode 100644 Documentation/networking/ixgb.txt
 create mode 100644 Documentation/networking/ixgbe.rst
 delete mode 100644 Documentation/networking/ixgbe.txt
 create mode 100644 Documentation/networking/ixgbevf.rst
 delete mode 100644 Documentation/networking/ixgbevf.txt

Comments

David Miller Oct. 18, 2018, 10:46 p.m. UTC | #1
From: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Date: Thu, 18 Oct 2018 13:32:46 -0700

> This series contains documentation fixes and updates for Intel wired LAN
> drivers.
> 
> The following was done:
>  - Updated incorrect URLs
>  - removed document references which did not apply to the current
>    in-kernel drivers
>  - added documentation for fm10k driver
>  - added missing documentation on existing or new features
>  - added SPDX headers to all the documentation files
> 
> Lastly, the documentation was converted over to the RST (reStructured
> Text) format, so that 'make htmldocs' produces pretty html driver
> documentation for our drivers.
> 
> The following are changes since commit 3a3295bfa6f484bba91de0a804c1d0bf7d31dbd3:
>   Merge branch 'sctp-fix-sk_wmem_queued-and-use-it-to-check-for-writable-space'
> and are available in the git repository at:
>   git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next-queue 10GbE

Pulled, thanks Jeff.