vfio: fix API description
authorYunjian Wang <wangyunjian@huawei.com>
Sat, 6 Jun 2020 09:17:20 +0000 (17:17 +0800)
committerDavid Marchand <david.marchand@redhat.com>
Wed, 3 Mar 2021 09:05:23 +0000 (10:05 +0100)
Fix few comments and add detailed comments for return value.

Fixes: 279b581c897d ("vfio: expose functions")
Cc: stable@dpdk.org
Signed-off-by: Yunjian Wang <wangyunjian@huawei.com>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
lib/librte_eal/include/rte_vfio.h

index 20ed8c4..e7a8745 100644 (file)
@@ -156,7 +156,7 @@ int rte_vfio_enable(const char *modname);
  *   kernel module name.
  *
  * @return
- *   !0 if true.
+ *   1 if true.
  *   0 otherwise.
  */
 int rte_vfio_is_enabled(const char *modname);
@@ -168,8 +168,9 @@ int rte_vfio_is_enabled(const char *modname);
  * an error on BSD.
  *
  * @return
- *   !0 if true.
- *   0 otherwise.
+ *   1 if true.
+ *   0 if false.
+ *   <0 for errors.
  */
 int rte_vfio_noiommu_is_enabled(void);