numam-dpdk/lib/eal/include
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
..
generic mcslock: use wait until scheme for unlock 2021-11-03 15:50:14 +01:00
meson.build interrupts: make interrupt handle structure opaque 2021-10-25 21:20:12 +02:00
rte_alarm.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_bitmap.h bitmap: fix buffer overrun in bitmap init 2021-06-11 11:03:25 +02:00
rte_bitops.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_branch_prediction.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_bus.h eal: remove sys/queue.h from public headers 2021-10-01 13:09:43 +02:00
rte_class.h eal: remove sys/queue.h from public headers 2021-10-01 13:09:43 +02:00
rte_common.h eal: add macro to swap two variables 2021-09-27 18:33:45 +02:00
rte_compat.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_debug.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_dev.h eal: remove sys/queue.h from public headers 2021-10-01 13:09:43 +02:00
rte_devargs.h eal: remove sys/queue.h from public headers 2021-10-01 13:09:43 +02:00
rte_eal_memconfig.h mem: promote some shared memory config API to stable 2021-09-28 22:07:41 +02:00
rte_eal_paging.h eal: fix memory mapping on 32-bit target 2021-05-11 23:01:06 +02:00
rte_eal_trace.h interrupts: rename device specific file descriptor 2021-10-25 21:20:12 +02:00
rte_eal.h eal: promote non-EAL lcore API as stable 2021-11-04 22:57:58 +01:00
rte_epoll.h interrupts: add allocator and accessors 2021-10-25 21:20:12 +02:00
rte_errno.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_fbarray.h fbarray: promote experimental API to stable 2021-09-28 22:07:41 +02:00
rte_function_versioning.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_hexdump.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_hypervisor.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_interrupts.h interrupts: extend event list 2021-10-25 21:20:12 +02:00
rte_keepalive.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_launch.h eal: remove FINISHED lcore state 2021-10-25 18:20:59 +02:00
rte_lcore.h eal: promote non-EAL lcore API as stable 2021-11-04 22:57:58 +01:00
rte_log.h log: promote some function to stable 2021-10-02 11:12:32 +02:00
rte_malloc.h malloc: promote some experimental API to stable 2021-09-28 22:07:41 +02:00
rte_memory.h mem: promote DMA mask API to stable 2021-09-28 22:07:41 +02:00
rte_memzone.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_pci_dev_feature_defs.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_pci_dev_features.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_per_lcore.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_random.h eal: promote random generator with upper bound to stable 2021-10-02 11:12:19 +02:00
rte_reciprocal.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_service_component.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_service.h eal: remove FINISHED lcore state 2021-10-25 18:20:59 +02:00
rte_string_fns.h eal: save error in string copy 2021-07-05 15:11:30 +02:00
rte_tailq.h eal: remove sys/queue.h from public headers 2021-10-01 13:09:43 +02:00
rte_test.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_thread.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_time.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_trace_point_register.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_trace_point.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_trace.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_uuid.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_version.h lib: remove librte_ prefix from directory names 2021-04-21 14:04:09 +02:00
rte_vfio.h vfio: fix FreeBSD documentation 2021-11-08 16:42:55 +01:00