diff mbox series

[v2,5/8] net/bonding: add bond_8023ad and bond_alb to doc

Message ID 1640116650-3475-6-git-send-email-rsanford@akamai.com (mailing list archive)
State Changes Requested, archived
Delegated to: Ferruh Yigit
Headers
Series net/bonding: fixes and LACP short timeout |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Robert Sanford Dec. 21, 2021, 7:57 p.m. UTC 
  - Add bond_8023ad and bond_alb to API documentation.

Signed-off-by: Robert Sanford <rsanford@akamai.com>
---
 doc/api/doxy-api-index.md | 2 ++
 1 file changed, 2 insertions(+)

Comments

Ferruh Yigit Feb. 4, 2022, 2:48 p.m. UTC | #1 
On 12/21/2021 7:57 PM, Robert Sanford wrote:
> - Add bond_8023ad and bond_alb to API documentation.
> 
> Signed-off-by: Robert Sanford <rsanford@akamai.com>
> ---
>   doc/api/doxy-api-index.md | 2 ++
>   1 file changed, 2 insertions(+)
> 
> diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> index 4245b96..830235c 100644
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -39,6 +39,8 @@ The public API headers are grouped by topics:
>   - **device specific**:
>     [softnic]            (@ref rte_eth_softnic.h),
>     [bond]               (@ref rte_eth_bond.h),
> +  [bond_8023ad]        (@ref rte_eth_bond_8023ad.h),

ack

> +  [bond_alb]           (@ref rte_eth_bond_alb.h),

'rte_eth_bond_alb.h' is not public header, it is not installed,
also functions in this header is not exported, so I think it
should not be part of API documentation.

>     [vhost]              (@ref rte_vhost.h),
>     [vdpa]               (@ref rte_vdpa.h),
>     [KNI]                (@ref rte_kni.h),
diff mbox series

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 4245b96..830235c 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -39,6 +39,8 @@  The public API headers are grouped by topics:
 - **device specific**:
   [softnic]            (@ref rte_eth_softnic.h),
   [bond]               (@ref rte_eth_bond.h),
+  [bond_8023ad]        (@ref rte_eth_bond_8023ad.h),
+  [bond_alb]           (@ref rte_eth_bond_alb.h),
   [vhost]              (@ref rte_vhost.h),
   [vdpa]               (@ref rte_vdpa.h),
   [KNI]                (@ref rte_kni.h),