[dpdk-stable] patch 'vfio: fix FreeBSD documentation' has been queued to stable release 20.11.4

[Xueming Li]

Hi,

FYI, your patch has been queued to stable release 20.11.4

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 11/12/21. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/steevenlee/dpdk

This queued commit can be viewed at:
https://github.com/steevenlee/dpdk/commit/971626cbed459b97576c21daefd5a24ef3b61d31

Thanks.

Xueming Li <xuemingl at nvidia.com>

---
>From 971626cbed459b97576c21daefd5a24ef3b61d31 Mon Sep 17 00:00:00 2001
From: Anatoly Burakov <anatoly.burakov at intel.com>
Date: Thu, 28 Oct 2021 14:15:18 +0000
Subject: [PATCH] vfio: fix FreeBSD documentation
Cc: Xueming Li <xuemingl at nvidia.com>

[ upstream commit da6e4cdca1144e2cc6f9f495a34d3085e707b78a ]

On FreeBSD, `rte_vfio_is_enabled()` and `rte_vfio_noiommu_is_enabled()`
API calls will not return error, and will instead return 0. This is
intentional, because the caller of this API does not care whether VFIO
is supported at all, and will instead be interested in whether VFIO is
enabled or not. However, the doxygen comments for these functions state
that they will return an error on FreeBSD, which is incorrect.

Fix the doxygen comment to call out the fact that these
functions are only relevant on Linux, but remove the reference to
returning errors.

Fixes: 279b581c897d ("vfio: expose functions")

Signed-off-by: Anatoly Burakov <anatoly.burakov at intel.com>
Acked-by: Chenbo Xia <chenbo.xia at intel.com>
---
 lib/librte_eal/include/rte_vfio.h | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/lib/librte_eal/include/rte_vfio.h b/lib/librte_eal/include/rte_vfio.h
index 2d90b36480..7bdb8932b2 100644
--- a/lib/librte_eal/include/rte_vfio.h
+++ b/lib/librte_eal/include/rte_vfio.h
@@ -150,8 +150,7 @@ int rte_vfio_enable(const char *modname);
 /**
  * Check whether a VFIO-related kmod is enabled.
  *
- * This function is only relevant to linux and will return
- * an error on BSD.
+ * This function is only relevant to Linux.
  *
  * @param modname
  *   kernel module name.
@@ -165,8 +164,7 @@ int rte_vfio_is_enabled(const char *modname);
 /**
  * Whether VFIO NOIOMMU mode is enabled.
  *
- * This function is only relevant to linux and will return
- * an error on BSD.
+ * This function is only relevant to Linux.
  *
  * @return
  *   1 if true.
-- 
2.33.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-11-10 14:17:12.760823204 +0800
+++ 0247-vfio-fix-FreeBSD-documentation.patch	2021-11-10 14:17:02.090744291 +0800
@@ -1 +1 @@
-From da6e4cdca1144e2cc6f9f495a34d3085e707b78a Mon Sep 17 00:00:00 2001
+From 971626cbed459b97576c21daefd5a24ef3b61d31 Mon Sep 17 00:00:00 2001
@@ -4,0 +5,3 @@
+Cc: Xueming Li <xuemingl at nvidia.com>
+
+[ upstream commit da6e4cdca1144e2cc6f9f495a34d3085e707b78a ]
@@ -18 +20,0 @@
-Cc: stable at dpdk.org
@@ -23 +25 @@
- lib/eal/include/rte_vfio.h | 6 ++----
+ lib/librte_eal/include/rte_vfio.h | 6 ++----
@@ -26 +28 @@
-diff --git a/lib/eal/include/rte_vfio.h b/lib/eal/include/rte_vfio.h
+diff --git a/lib/librte_eal/include/rte_vfio.h b/lib/librte_eal/include/rte_vfio.h
@@ -28,2 +30,2 @@
---- a/lib/eal/include/rte_vfio.h
-+++ b/lib/eal/include/rte_vfio.h
+--- a/lib/librte_eal/include/rte_vfio.h
++++ b/lib/librte_eal/include/rte_vfio.h