[v6,1/2] doc: add vfio api support

Message ID 1523514217-12580-1-git-send-email-hemant.agrawal@nxp.com
State New
Headers show
Series
  • [v6,1/2] doc: add vfio api support
Related show

Commit Message

Hemant Agrawal April 12, 2018, 6:23 a.m.
Signed-off-by: Hemant Agrawal <hemant.agrawal@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(-)

-- 
2.7.4

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 2f04619..d5ccbe8 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -52,7 +52,8 @@  The public API headers are grouped by topics:
   [bitrate]            (@ref rte_bitrate.h),
   [latency]            (@ref rte_latencystats.h),
   [devargs]            (@ref rte_devargs.h),
-  [PCI]                (@ref rte_pci.h)
+  [PCI]                (@ref rte_pci.h),
+  [vfio]               (@ref rte_vfio.h)
 
 - **device specific**:
   [softnic]            (@ref rte_eth_softnic.h),
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index cda52fd..ad8bdcf 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 d26ab01..f363cac 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
  */