doc: add meter, sched, power and KNI
PATCH 1/1 doc: add meter, sched, power and KNI
KNI was new in DPDK 1.3.
The libraries meter, sched and power were new in DPDK 1.4. The library sched includes some dependencies: approx, bitmap and red.
--- doc/doxy-api-index.md | 17 +++++++++++++---- doc/doxy-api.conf | 4 ++++ 2 files changed, 17 insertions(+), 4 deletions(-)
doc/doxy-api-index.md +13 -4
@@ -37,6 +37,7 @@ There are many libraries, so their headers may be grouped by topics: - **device**: [ethdev] (@ref rte_ethdev.h), + [KNI] (@ref rte_kni.h), [PCI] (@ref rte_pci.h), [PCI IDs] (@ref rte_pci_dev_ids.h)
@@ -57,17 +58,18 @@ There are many libraries, so their headers may be grouped by topics: [rwlock] (@ref rte_rwlock.h), [spinlock] (@ref rte_spinlock.h) -- **cpu arch**: +- **CPU arch**: [branch prediction] (@ref rte_branch_prediction.h), [cache prefetch] (@ref rte_prefetch.h), [byte order] (@ref rte_byteorder.h), [CPU flags] (@ref rte_cpuflags.h) -- **cpu multicore**: +- **CPU multicore**: [interrupts] (@ref rte_interrupts.h), [launch] (@ref rte_launch.h), [lcore] (@ref rte_lcore.h), - [per-lcore] (@ref rte_per_lcore.h) + [per-lcore] (@ref rte_per_lcore.h), + [power/freq] (@ref rte_power.h) - **layers**: [ethernet] (@ref rte_ether.h),
@@ -77,6 +79,11 @@ There are many libraries, so their headers may be grouped by topics: [UDP] (@ref rte_udp.h), [LPM route] (@ref rte_lpm.h) +- **QoS**: + [metering] (@ref rte_meter.h), + [scheduler] (@ref rte_sched.h), + [RED congestion] (@ref rte_red.h) + - **hashes**: [hash] (@ref rte_hash.h), [jhash] (@ref rte_jhash.h),
@@ -86,7 +93,8 @@ There are many libraries, so their headers may be grouped by topics: - **containers**: [mbuf] (@ref rte_mbuf.h), [ring] (@ref rte_ring.h), - [tailq] (@ref rte_tailq.h) + [tailq] (@ref rte_tailq.h), + [bitmap] (@ref rte_bitmap.h) - **debug**: [debug] (@ref rte_debug.h),
@@ -97,6 +105,7 @@ There are many libraries, so their headers may be grouped by topics: - **misc**: [EAL config] (@ref rte_eal.h), [common] (@ref rte_common.h), + [approx fraction] (@ref rte_approx.h), [random] (@ref rte_random.h), [string] (@ref rte_string_fns.h), [version] (@ref rte_version.h)
doc/doxy-api.conf +4 -0
@@ -33,12 +33,16 @@ INPUT = doc/doxy-api-index.md \ lib/librte_eal/common/include \ lib/librte_ether \ lib/librte_hash \ + lib/librte_kni \ lib/librte_lpm \ lib/librte_malloc \ lib/librte_mbuf \ lib/librte_mempool \ + lib/librte_meter \ lib/librte_net \ + lib/librte_power \ lib/librte_ring \ + lib/librte_sched \ lib/librte_timer FILE_PATTERNS = rte_*.h \ cmdline.h
Signature · 1 line
1.7.10.4
A message that is not in the archive (sent off-list or not yet received): 1379499461-25593-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org
David Marchand
Acked-byOn Wed, Sep 18, 2013 at 12:17 PM, Thomas Monjalon <[email protected]
Quoted 8 lines
wrote:
KNI was new in DPDK 1.3.
The libraries meter, sched and power were new in DPDK 1.4. The library sched includes some dependencies: approx, bitmap and red.Signed-off-by Thomas Monjalon <[email protected]>
Signature · 1 line
David Marchand
A message that is not in the archive (sent off-list or not yet received): CALwxeUvB36K6j0bb1s-k3ZO0vRcFV01pu38FR+bRaTZbzpwUBg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org
30/09/2013 10:41, David Marchand :
Quoted 9 lines · Thomas Monjalon
Quoted 6 lines
KNI was new in DPDK 1.3.
The libraries meter, sched and power were new in DPDK 1.4. The library sched includes some dependencies: approx, bitmap and red.Signed-off-by Thomas Monjalon <[email protected]>Acked-by David Marchand <[email protected]>
pushed
Signature · 1 line
Thomas