diff mbox

[dpdk-dev] doc: move metrics libs to device API section

Message ID 20170803155605.31031-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail apply patch file failure

Commit Message

Thomas Monjalon Aug. 3, 2017, 3:56 p.m. UTC 
  The metrics headers were listed in misc section,
whereas they belong to the device API family.

Fixes: 349950ddb9c5 ("metrics: add information metrics library")
Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
Fixes: 5cd3cac9ed22 ("latency: added new library for latency stats")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/api/doxy-api-index.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

John McNamara Aug. 3, 2017, 4:07 p.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Thursday, August 3, 2017 4:56 PM
> To: Horton, Remy <remy.horton@intel.com>
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: move metrics libs to device API section
> 
> The metrics headers were listed in misc section, whereas they belong to
> the device API family.
> 
> Fixes: 349950ddb9c5 ("metrics: add information metrics library")
> Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
> Fixes: 5cd3cac9ed22 ("latency: added new library for latency stats")
> 

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Aug. 3, 2017, 11:30 p.m. UTC | #2 
> > The metrics headers were listed in misc section, whereas they belong to
> > the device API family.
> > 
> > Fixes: 349950ddb9c5 ("metrics: add information metrics library")
> > Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
> > Fixes: 5cd3cac9ed22 ("latency: added new library for latency stats")
> > 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied
diff mbox

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 1fd7ff17b..19e0d4f3d 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -43,6 +43,9 @@  The public API headers are grouped by topics:
   [rte_tm]             (@ref rte_tm.h),
   [cryptodev]          (@ref rte_cryptodev.h),
   [eventdev]           (@ref rte_eventdev.h),
+  [metrics]            (@ref rte_metrics.h),
+  [bitrate]            (@ref rte_bitrate.h),
+  [latency]            (@ref rte_latencystats.h),
   [devargs]            (@ref rte_devargs.h),
   [PCI]                (@ref rte_pci.h)
 
@@ -161,7 +164,4 @@  The public API headers are grouped by topics:
   [EAL config]         (@ref rte_eal.h),
   [common]             (@ref rte_common.h),
   [ABI compat]         (@ref rte_compat.h),
-  [device metrics]     (@ref rte_metrics.h),
-  [bitrate statistics] (@ref rte_bitrate.h),
-  [latency statistics] (@ref rte_latencystats.h),
   [version]            (@ref rte_version.h)