[dpdk-dev] [PATCH v3 1/2] doc: add vfio api support

Hemant Agrawal hemant.agrawal at nxp.com
Tue Apr 3 10:28:05 CEST 2018


Signed-off-by: Hemant Agrawal <hemant.agrawal at nxp.com>
---
 doc/api/doxy-api-index.md                | 3 ++-
 doc/api/doxy-api.conf                    | 1 +
 lib/librte_eal/common/include/rte_vfio.h | 5 +++++
 3 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index d77f205..12c1ebe 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -179,4 +179,5 @@ The public API headers are grouped by topics:
   [EAL config]         (@ref rte_eal.h),
   [common]             (@ref rte_common.h),
   [ABI compat]         (@ref rte_compat.h),
-  [version]            (@ref rte_version.h)
+  [version]            (@ref rte_version.h),
+  [vfio]               (@ref rte_vfio.h)
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index cda52fd..166612f 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -82,6 +82,7 @@ INPUT                   = doc/api/doxy-api-index.md \
 FILE_PATTERNS           = rte_*.h \
                           cmdline.h
 PREDEFINED              = __DOXYGEN__ \
+			  VFIO_PRESENT \
                           __attribute__(x)=
 
 OPTIMIZE_OUTPUT_FOR_C   = YES
diff --git a/lib/librte_eal/common/include/rte_vfio.h b/lib/librte_eal/common/include/rte_vfio.h
index 249095e..9b7b983 100644
--- a/lib/librte_eal/common/include/rte_vfio.h
+++ b/lib/librte_eal/common/include/rte_vfio.h
@@ -5,6 +5,11 @@
 #ifndef _RTE_VFIO_H_
 #define _RTE_VFIO_H_
 
+/**
+ * @file
+ * RTE VFIO. This library provides various VFIO related utility functions.
+ */
+
 /*
  * determine if VFIO is present on the system
  */
-- 
2.7.4



More information about the dev mailing list