| Message ID | 20201126142638.25349-1-olivier.matz@6wind.com |
|---|---|
| State | Accepted, archived |
| Delegated to: | Thomas Monjalon |
| Headers | show |
| Series |
|
| Related | show |
| Context | Check | Description |
|---|---|---|
| ci/Intel-compilation | success | Compilation OK |
| ci/travis-robot | success | Travis build: passed |
| ci/iol-mellanox-Performance | success | Performance Testing PASS |
| ci/iol-intel-Performance | success | Performance Testing PASS |
| ci/iol-intel-Functional | success | Functional Testing PASS |
| ci/iol-testing | success | Testing PASS |
| ci/iol-broadcom-Performance | success | Performance Testing PASS |
| ci/iol-broadcom-Functional | success | Functional Testing PASS |
| ci/checkpatch | success | coding style OK |
26/11/2020 15:26, Olivier Matz: > Add missing files in doxy-api-index.md and add a short description > for files that hadn't one. > > Signed-off-by: Olivier Matz <olivier.matz@6wind.com> > --- > + [VXLAN] (@ref rte_vxlan.h), > + [eCPRI] (@ref rte_ecpri.h), > + [Geneve] (@ref rte_geneve.h), > + [GRE] (@ref rte_gre.h), > + [ICMP] (@ref rte_icmp.h), > + [MPLS] (@ref rte_mpls.h) ICMP was already in the list. Applied with minor fixes, thanks.
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index bf6edb0276..a6e729de35 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -114,7 +114,12 @@ The public API headers are grouped by topics: [GRO] (@ref rte_gro.h), [GSO] (@ref rte_gso.h), [frag/reass] (@ref rte_ip_frag.h), - [VXLAN] (@ref rte_vxlan.h) + [VXLAN] (@ref rte_vxlan.h), + [eCPRI] (@ref rte_ecpri.h), + [Geneve] (@ref rte_geneve.h), + [GRE] (@ref rte_gre.h), + [ICMP] (@ref rte_icmp.h), + [MPLS] (@ref rte_mpls.h) - **QoS**: [metering] (@ref rte_meter.h), diff --git a/lib/librte_net/rte_ecpri.h b/lib/librte_net/rte_ecpri.h index 1cbd6d8133..3f3a90335b 100644 --- a/lib/librte_net/rte_ecpri.h +++ b/lib/librte_net/rte_ecpri.h @@ -5,6 +5,15 @@ #ifndef _RTE_ECPRI_H_ #define _RTE_ECPRI_H_ +/** + * @file + * + * eCPRI headers definition. + * + * eCPRI (Common Public Radio Interface) is used in internal interfaces of radio + * base station in a 5G infrastructure. + */ + #include <stdint.h> #include <rte_byteorder.h> diff --git a/lib/librte_net/rte_gre.h b/lib/librte_net/rte_gre.h index ac3ddaada3..79f0fa8ff2 100644 --- a/lib/librte_net/rte_gre.h +++ b/lib/librte_net/rte_gre.h @@ -8,6 +8,17 @@ #include <stdint.h> #include <rte_byteorder.h> +/** + * @file + * + * GRE headers definition. + * + * Generic Routing Encapsulation (GRE) is a tunneling protocol that can + * encapsulate a wide variety of network layer protocols inside virtual + * point-to-point links or point-to-multipoint links over an Internet Protocol + * network. + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/lib/librte_net/rte_higig.h b/lib/librte_net/rte_higig.h index b9cdfefed7..cc51ec021a 100644 --- a/lib/librte_net/rte_higig.h +++ b/lib/librte_net/rte_higig.h @@ -6,6 +6,14 @@ #ifndef _RTE_HIGIG_H_ #define _RTE_HIGIG_H_ +/** + * @file + * + * HIGIG2 headers definition. + * + * It is a layer 2.5 protocol and used in Broadcom switches. + */ + #include <stdint.h> #include <rte_byteorder.h>
Add missing files in doxy-api-index.md and add a short description for files that hadn't one. Signed-off-by: Olivier Matz <olivier.matz@6wind.com> --- doc/api/doxy-api-index.md | 7 ++++++- lib/librte_net/rte_ecpri.h | 9 +++++++++ lib/librte_net/rte_gre.h | 11 +++++++++++ lib/librte_net/rte_higig.h | 8 ++++++++ 4 files changed, 34 insertions(+), 1 deletion(-)