numam-dpdk/lib/eal
Anatoly Burakov da6e4cdca1 vfio: fix FreeBSD documentation
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: 279b581c89 ("vfio: expose functions")
Cc: stable@dpdk.org

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Chenbo Xia <chenbo.xia@intel.com>
2021-11-08 16:42:55 +01:00
..
arm eal: add a new helper for wait until scheme 2021-11-03 15:50:14 +01:00
common malloc: fix allocation with unknown socket ID 2021-11-05 15:28:49 +01:00
freebsd vfio: fix FreeBSD clear group stub 2021-11-08 16:42:44 +01:00
include vfio: fix FreeBSD documentation 2021-11-08 16:42:55 +01:00
linux vfio: drop fallback Linux implementation 2021-11-08 16:27:15 +01:00
ppc eal/ppc: use compiler builtins for atomics 2021-10-14 16:51:25 +02:00
unix eal: handle compressed firmware 2021-07-07 16:41:53 +02:00
windows eal/windows: fix IOVA mode detection and handling 2021-10-25 20:59:40 +02:00
x86 eal/x86: avoid cast-align warning in memcpy functions 2021-10-25 17:28:12 +02:00
meson.build lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
version.map eal: promote non-EAL lcore API as stable 2021-11-04 22:57:58 +01:00