[dpdk-dev] doc: move keepalive to multicore API section

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

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon Aug. 3, 2017, 3:55 p.m. UTC
  The keepalive header was listed in misc section,
despite its doxygen comment is "LCore Keepalive Monitor".

Fixes: 75583b0d1efd ("eal: add keep alive monitoring")

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

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:55 PM
> To: Horton, Remy <remy.horton@intel.com>
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: move keepalive to multicore API section
> 
> The keepalive header was listed in misc section, despite its doxygen
> comment is "LCore Keepalive Monitor".
> 
> Fixes: 75583b0d1efd ("eal: add keep alive monitoring")
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>


Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon Aug. 3, 2017, 11:30 p.m. UTC | #2
> > The keepalive header was listed in misc section, despite its doxygen
> > comment is "LCore Keepalive Monitor".
> > 
> > Fixes: 75583b0d1efd ("eal: add keep alive monitoring")
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied
  

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 04034ae78..1fd7ff17b 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -86,6 +86,7 @@  The public API headers are grouped by topics:
   [lcore]              (@ref rte_lcore.h),
   [per-lcore]          (@ref rte_per_lcore.h),
   [service cores]      (@ref rte_service.h),
+  [keepalive]          (@ref rte_keepalive.h),
   [power/freq]         (@ref rte_power.h)
 
 - **layers**:
@@ -160,7 +161,6 @@  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),
-  [keepalive]          (@ref rte_keepalive.h),
   [device metrics]     (@ref rte_metrics.h),
   [bitrate statistics] (@ref rte_bitrate.h),
   [latency statistics] (@ref rte_latencystats.h),