[dpdk-dev,v3] doc: add device specific API
Checks
Commit Message
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
v3:
* remove "," after [PCI]
---
doc/api/doxy-api-index.md | 6 +++++-
doc/api/doxy-api.conf | 2 ++
2 files changed, 7 insertions(+), 1 deletion(-)
Comments
2017-01-30 18:27, Ferruh Yigit:
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Applied, thanks
2017-01-30 21:21, Thomas Monjalon:
> 2017-01-30 18:27, Ferruh Yigit:
> > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>
> Applied, thanks
Actually no, there are a lot of doxygen errors in ixgbe and i40e API.
I cannot be merged as is.
On 1/30/2017 8:25 PM, Thomas Monjalon wrote:
> 2017-01-30 21:21, Thomas Monjalon:
>> 2017-01-30 18:27, Ferruh Yigit:
>>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>>
>> Applied, thanks
>
> Actually no, there are a lot of doxygen errors in ixgbe and i40e API.
> I cannot be merged as is.
I already fixed and merged ixgbe and i40e doxygen errors in next-net.
2017-01-30 20:27, Ferruh Yigit:
> On 1/30/2017 8:25 PM, Thomas Monjalon wrote:
> > 2017-01-30 21:21, Thomas Monjalon:
> >> 2017-01-30 18:27, Ferruh Yigit:
> >>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> >>
> >> Applied, thanks
> >
> > Actually no, there are a lot of doxygen errors in ixgbe and i40e API.
> > I cannot be merged as is.
>
> I already fixed and merged ixgbe and i40e doxygen errors in next-net.
OK, good to know.
@@ -43,10 +43,14 @@ There are many libraries, so their headers may be grouped by topics:
[rte_flow_driver] (@ref rte_flow_driver.h),
[cryptodev] (@ref rte_cryptodev.h),
[devargs] (@ref rte_devargs.h),
+ [PCI] (@ref rte_pci.h)
+
+- **device specific**:
[bond] (@ref rte_eth_bond.h),
[vhost] (@ref rte_virtio_net.h),
[KNI] (@ref rte_kni.h),
- [PCI] (@ref rte_pci.h),
+ [ixgbe] (@ref rte_pmd_ixgbe.h),
+ [i40e] (@ref rte_pmd_i40e.h)
- **memory**:
[memseg] (@ref rte_memory.h),
@@ -32,6 +32,8 @@ PROJECT_NAME = DPDK
INPUT = doc/api/doxy-api-index.md \
doc/api/examples.dox \
drivers/net/bonding \
+ drivers/net/i40e \
+ drivers/net/ixgbe \
lib/librte_eal/common/include \
lib/librte_eal/common/include/generic \
lib/librte_acl \