doc: add rib and fib into the API doxygen index
Checks
Commit Message
Add RIB/FIB library into the API doxygen index.
Move LPM/LPM6 under separate section "Longest prefix match"
Fixes: 5a5793a5ffa2 ("rib: add RIB library")
Fixes: f7e861e21c46 ("rib: support IPv6")
Fixes: 39e927248416 ("fib: add FIB library")
Fixes: 40d41a8a7b34 ("fib: support IPv6")
Cc: stable@dpdk.org
Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
---
doc/api/doxy-api-index.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
Comments
06/07/2020 19:00, Vladimir Medvedkin:
> Add RIB/FIB library into the API doxygen index.
> Move LPM/LPM6 under separate section "Longest prefix match"
[...]
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> - **QoS**:
> @@ -116,6 +114,14 @@ The public API headers are grouped by topics:
> [scheduler] (@ref rte_sched.h),
> [RED congestion] (@ref rte_red.h)
>
> +- **Longest prefix match**:
I would have thought to "routing" as title of this section.
Is "longest prefix match" better?
> + [LPM IPv4 route] (@ref rte_lpm.h),
> + [LPM IPv6 route] (@ref rte_lpm6.h),
> + [RIB IPv4] (@ref rte_rib.h),
> + [RIB IPv6] (@ref rte_rib6.h),
> + [FIB IPv4] (@ref rte_fib.h),
> + [FIB IPv6] (@ref rte_fib6.h)
> +
> - **hashes**:
> [hash] (@ref rte_hash.h),
> [jhash] (@ref rte_jhash.h),
Hi Thomas,
On 06/07/2020 20:31, Thomas Monjalon wrote:
> 06/07/2020 19:00, Vladimir Medvedkin:
>> Add RIB/FIB library into the API doxygen index.
>> Move LPM/LPM6 under separate section "Longest prefix match"
> [...]
>> --- a/doc/api/doxy-api-index.md
>> +++ b/doc/api/doxy-api-index.md
>> - **QoS**:
>> @@ -116,6 +114,14 @@ The public API headers are grouped by topics:
>> [scheduler] (@ref rte_sched.h),
>> [RED congestion] (@ref rte_red.h)
>>
>> +- **Longest prefix match**:
>
> I would have thought to "routing" as title of this section.
> Is "longest prefix match" better?
I don't have any objections regarding "routing". Do you need me resend
patch?
>
>> + [LPM IPv4 route] (@ref rte_lpm.h),
>> + [LPM IPv6 route] (@ref rte_lpm6.h),
>> + [RIB IPv4] (@ref rte_rib.h),
>> + [RIB IPv6] (@ref rte_rib6.h),
>> + [FIB IPv4] (@ref rte_fib.h),
>> + [FIB IPv6] (@ref rte_fib6.h)
>> +
>> - **hashes**:
>> [hash] (@ref rte_hash.h),
>> [jhash] (@ref rte_jhash.h),
>
>
>
>
08/07/2020 15:56, Medvedkin, Vladimir:
> Hi Thomas,
>
> On 06/07/2020 20:31, Thomas Monjalon wrote:
> > 06/07/2020 19:00, Vladimir Medvedkin:
> >> Add RIB/FIB library into the API doxygen index.
> >> Move LPM/LPM6 under separate section "Longest prefix match"
> > [...]
> >> --- a/doc/api/doxy-api-index.md
> >> +++ b/doc/api/doxy-api-index.md
> >> - **QoS**:
> >> @@ -116,6 +114,14 @@ The public API headers are grouped by topics:
> >> [scheduler] (@ref rte_sched.h),
> >> [RED congestion] (@ref rte_red.h)
> >>
> >> +- **Longest prefix match**:
> >
> > I would have thought to "routing" as title of this section.
> > Is "longest prefix match" better?
>
> I don't have any objections regarding "routing". Do you need me resend
> patch?
If you think "routing" is more descriptive, yes please send a v2.
> >> + [LPM IPv4 route] (@ref rte_lpm.h),
> >> + [LPM IPv6 route] (@ref rte_lpm6.h),
> >> + [RIB IPv4] (@ref rte_rib.h),
> >> + [RIB IPv6] (@ref rte_rib6.h),
> >> + [FIB IPv4] (@ref rte_fib.h),
> >> + [FIB IPv6] (@ref rte_fib6.h)
> >> +
> >> - **hashes**:
> >> [hash] (@ref rte_hash.h),
> >> [jhash] (@ref rte_jhash.h),
@@ -107,8 +107,6 @@ 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),
- [LPM IPv4 route] (@ref rte_lpm.h),
- [LPM IPv6 route] (@ref rte_lpm6.h),
[VXLAN] (@ref rte_vxlan.h)
- **QoS**:
@@ -116,6 +114,14 @@ The public API headers are grouped by topics:
[scheduler] (@ref rte_sched.h),
[RED congestion] (@ref rte_red.h)
+- **Longest prefix match**:
+ [LPM IPv4 route] (@ref rte_lpm.h),
+ [LPM IPv6 route] (@ref rte_lpm6.h),
+ [RIB IPv4] (@ref rte_rib.h),
+ [RIB IPv6] (@ref rte_rib6.h),
+ [FIB IPv4] (@ref rte_fib.h),
+ [FIB IPv6] (@ref rte_fib6.h)
+
- **hashes**:
[hash] (@ref rte_hash.h),
[jhash] (@ref rte_jhash.h),