[dpdk-dev] [PATCH v7 6/6] Link Bonding Library doxygen additions
2014-06-25 14:19, Doherty, Declan: > > -Original Message- > > From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com] > > Sent: Wednesday, June 25, 2014 2:44 PM > > To: Doherty, Declan > > Cc: dev at dpdk.org > > Subject: Re: [PATCH v7 6/6] Link Bonding Library doxygen additions > > > > Hi Declan, > > > > Since bonding library is a PMD, there should have no need of integrate it > > in the API documentation. > > I hadn't time to review it yet, so I would miss something. > > Do you mean it can be used directly by the application with a specific > > API? > > In this case, you could explain it in the commit log. > > Hi Thomas, the bonding library has a API which supports creation and > management of bonded devices directly from within applications, but more > importantly provides the APIs required to dynamically add and remove slaves > from a bonded device, this functionality will be required to support live > migration of VMs using bonded ports in a future releases. OK. Could I suggest to split rte_eth_bond.c in 2 files? 1 file for the library matching the API and 1 file for the PMD layer? I feel it would be easier to read and maintain. Thanks -- Thomas
[dpdk-dev] [PATCH v7 6/6] Link Bonding Library doxygen additions
Hi Declan,
Since bonding library is a PMD, there should have no need of integrate it
in the API documentation.
I hadn't time to review it yet, so I would miss something.
Do you mean it can be used directly by the application with a specific API?
In this case, you could explain it in the commit log.
2014-06-24 17:03, Declan Doherty:
> --- a/doc/doxy-api-index.md
> +++ b/doc/doxy-api-index.md
> @@ -36,6 +36,7 @@ API {#index}
> There are many libraries, so their headers may be grouped by topics:
>
> - **device**:
> + [bond] (@ref rte_eth_bond.h),
>[ethdev] (@ref rte_ethdev.h),
>[devargs](@ref rte_devargs.h),
>[KNI](@ref rte_kni.h),
ethdev should be first in this list.
> --- a/doc/doxy-api.conf
> +++ b/doc/doxy-api.conf
> @@ -30,6 +30,7 @@
>
> PROJECT_NAME= DPDK
> INPUT = doc/doxy-api-index.md \
> + lib/librte_pmd_bond \
>lib/librte_eal/common/include \
>lib/librte_acl \
>lib/librte_distributor \
Libraries should be in alphabetical order here.
Thanks
--
Thomas
[dpdk-dev] [PATCH v7 6/6] Link Bonding Library doxygen additions
> -Original Message- > From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com] > Sent: Wednesday, June 25, 2014 2:44 PM > To: Doherty, Declan > Cc: dev at dpdk.org > Subject: Re: [PATCH v7 6/6] Link Bonding Library doxygen additions > > Hi Declan, > > Since bonding library is a PMD, there should have no need of integrate it > in the API documentation. > I hadn't time to review it yet, so I would miss something. > Do you mean it can be used directly by the application with a specific API? > In this case, you could explain it in the commit log. > Hi Thomas, the bonding library has a API which supports creation and management of bonded devices directly from within applications, but more importantly provides the APIs required to dynamically add and remove slaves from a bonded device, this functionality will be required to support live migration of VMs using bonded ports in a future releases.
[dpdk-dev] [PATCH v7 6/6] Link Bonding Library doxygen additions
Signed-off-by: Declan Doherty
---
doc/doxy-api-index.md |1 +
doc/doxy-api.conf |1 +
2 files changed, 2 insertions(+), 0 deletions(-)
diff --git a/doc/doxy-api-index.md b/doc/doxy-api-index.md
index 7b26e98..ee3ad4f 100644
--- a/doc/doxy-api-index.md
+++ b/doc/doxy-api-index.md
@@ -36,6 +36,7 @@ API {#index}
There are many libraries, so their headers may be grouped by topics:
- **device**:
+ [bond] (@ref rte_eth_bond.h),
[ethdev] (@ref rte_ethdev.h),
[devargs](@ref rte_devargs.h),
[KNI](@ref rte_kni.h),
diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf
index f380d9a..b15a340 100644
--- a/doc/doxy-api.conf
+++ b/doc/doxy-api.conf
@@ -30,6 +30,7 @@
PROJECT_NAME= DPDK
INPUT = doc/doxy-api-index.md \
+ lib/librte_pmd_bond \
lib/librte_eal/common/include \
lib/librte_acl \
lib/librte_distributor \
--
1.7.0.7
