diff mbox series

doc: update matching list recommendations

Message ID 20231110121407.444282-1-ktraynor@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: Qi Zhang
Headers
Series doc: update matching list recommendations |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS

Commit Message

Kevin Traynor Nov. 10, 2023, 12:14 p.m. UTC 
  Update documentation to stop recommending that
out-of-tree Linux Kernel drivers are used for
i40e and ice.

Cc: stable@dpdk.org

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>

---
Sent mail explaining background here:
http://inbox.dpdk.org/dev/d212cb6e-53fd-b017-0d93-ff0b014768c4@redhat.com/
---
 doc/guides/nics/i40e.rst | 13 ++++++++-----
 doc/guides/nics/ice.rst  | 15 +++++++++------
 2 files changed, 17 insertions(+), 11 deletions(-)

Comments

Qi Zhang Nov. 15, 2023, 8:06 a.m. UTC | #1 
> -----Original Message-----
> From: Kevin Traynor <ktraynor@redhat.com>
> Sent: Friday, November 10, 2023 8:14 PM
> To: Zhang, Yuying <yuying.zhang@intel.com>; Xing, Beilei
> <beilei.xing@intel.com>; Yang, Qiming <qiming.yang@intel.com>; Zhang, Qi Z
> <qi.z.zhang@intel.com>
> Cc: dev@dpdk.org; Kevin Traynor <ktraynor@redhat.com>; stable@dpdk.org
> Subject: [PATCH] doc: update matching list recommendations
> 
> Update documentation to stop recommending that out-of-tree Linux Kernel
> drivers are used for i40e and ice.
> 
> Cc: stable@dpdk.org
> 
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>

Acked-by: Qi Zhang <qi.z.zhang@intel.com>

Applied to dpdk-next-net-intel.

Thanks
Qi
diff mbox series

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 791e9553bc..8b2a94060c 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -89,11 +89,14 @@  Windows Prerequisites
   <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
 
-Recommended Matching List
--------------------------
+Kernel driver and Firmware Matching List
+----------------------------------------
 
 It is highly recommended to upgrade the i40e kernel driver and firmware to
-avoid the compatibility issues with i40e PMD. Here is the suggested matching
-list which has been tested and verified. The detailed information can refer
-to chapter Tested Platforms/Tested NICs in release notes.
+avoid the compatibility issues with i40e PMD. The table below shows a
+summary of the DPDK versions with corresponding out-of-tree Linux kernel
+drivers and Firmware. The full list of in-tree and out-of-tree Linux kernel
+drivers from kernel.org and Linux distributions that were tested and verified
+are listed in the Tested Platforms section of the Release notes for each
+release.
 
 For X710/XL710/XXV710,
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 6e71aac3c2..0f7a797ad5 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -42,11 +42,14 @@  Windows Prerequisites
 
 
-Recommended Matching List
--------------------------
+Kernel driver, DDP and Firmware Matching List
+---------------------------------------------
 
-It is highly recommended to upgrade the ice kernel driver, firmware and DDP package
-to avoid the compatibility issues with ice PMD.
-Here is the suggested matching list which has been tested and verified.
-The detailed information can refer to chapter Tested Platforms/Tested NICs in release notes.
+It is highly recommended to upgrade the ice kernel driver, firmware and DDP
+package to avoid the compatibility issues with ice PMD. The table below shows
+a summary of the DPDK versions with corresponding out-of-tree Linux kernel
+drivers, DDP package and Firmware. The full list of in-tree and out-of-tree
+Linux kernel drivers from kernel.org and Linux distributions that were tested
+and verified are listed in the Tested Platforms section of the Release notes
+for each release.
 
    +-----------+---------------+-----------------+-----------+--------------+-----------+