vfio: fix FreeBSD documentation
authorAnatoly Burakov <anatoly.burakov@intel.com>
Thu, 28 Oct 2021 14:15:18 +0000 (14:15 +0000)
committerDavid Marchand <david.marchand@redhat.com>
Mon, 8 Nov 2021 15:42:55 +0000 (16:42 +0100)
commitda6e4cdca1144e2cc6f9f495a34d3085e707b78a
tree8b337f4a0f3619b28b263a46c2e774feae46880a
parentbf8b792f3b8519fecf3585ffac15da6f7bca2de9
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: 279b581c897d ("vfio: expose functions")
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Chenbo Xia <chenbo.xia@intel.com>
lib/eal/include/rte_vfio.h