DPDK patches and discussions
 help / color / mirror / Atom feed
From: Harry van Haaren <harry.van.haaren@intel.com>
To: remy.horton@intel.com
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v2 1/3] doc: fix keepalive sample app guide
Date: Thu, 21 Jan 2016 11:05:25 +0000	[thread overview]
Message-ID: <1453374327-26635-2-git-send-email-harry.van.haaren@intel.com> (raw)
In-Reply-To: <1453374327-26635-1-git-send-email-harry.van.haaren@intel.com>

This patch fixes some mismatches between the keepalive code
and the docs. Struct names, and descriptions are not in line
with the codebase.

Fixes: e64833f2273a ("examples/l2fwd-keepalive: add sample application")

Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
---
 doc/guides/sample_app_ug/keep_alive.rst | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/doc/guides/sample_app_ug/keep_alive.rst b/doc/guides/sample_app_ug/keep_alive.rst
index 080811b..1478faf 100644
--- a/doc/guides/sample_app_ug/keep_alive.rst
+++ b/doc/guides/sample_app_ug/keep_alive.rst
@@ -1,6 +1,6 @@
 
 ..  BSD LICENSE
-    Copyright(c) 2015 Intel Corporation. All rights reserved.
+    Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without
@@ -143,17 +143,17 @@ The Keep-Alive/'Liveliness' conceptual scheme:
 The following sections provide some explanation of the code aspects
 that are specific to the Keep Alive sample application.
 
-The heartbeat functionality is initialized with a struct
-rte_heartbeat and the callback function to invoke in the
+The keepalive functionality is initialized with a struct
+rte_keepalive and the callback function to invoke in the
 case of a timeout.
 
 .. code-block:: c
 
     rte_global_keepalive_info = rte_keepalive_create(&dead_core, NULL);
-    if (rte_global_hbeat_info == NULL)
+    if (rte_global_keepalive_info == NULL)
         rte_exit(EXIT_FAILURE, "keepalive_create() failed");
 
-The function that issues the pings hbeat_dispatch_pings()
+The function that issues the pings keepalive_dispatch_pings()
 is configured to run every check_period milliseconds.
 
 .. code-block:: c
@@ -162,7 +162,8 @@ is configured to run every check_period milliseconds.
             (check_period * rte_get_timer_hz()) / 1000,
             PERIODICAL,
             rte_lcore_id(),
-            &hbeat_dispatch_pings, rte_global_keepalive_info
+            &rte_keepalive_dispatch_pings,
+            rte_global_keepalive_info
             ) != 0 )
         rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
 
@@ -173,7 +174,7 @@ functionality and the example random failures.
 
 .. code-block:: c
 
-    rte_keepalive_mark_alive(&rte_global_hbeat_info);
+    rte_keepalive_mark_alive(&rte_global_keepalive_info);
     cur_tsc = rte_rdtsc();
 
     /* Die randomly within 7 secs for demo purposes.. */
@@ -185,7 +186,7 @@ The rte_keepalive_mark_alive function simply sets the core state to alive.
 .. code-block:: c
 
     static inline void
-    rte_keepalive_mark_alive(struct rte_heartbeat *keepcfg)
+    rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
     {
-        keepcfg->state_flags[rte_lcore_id()] = 1;
+        keepcfg->state_flags[rte_lcore_id()] = ALIVE;
     }
-- 
2.5.0

  reply	other threads:[~2016-01-21 11:06 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-20 15:53 [dpdk-dev] [PATCH 0/3] Keep-alive stats and doc fixes Harry van Haaren
2016-01-20 15:53 ` [dpdk-dev] [PATCH 1/3] doc: fix keepalive sample app guide Harry van Haaren
2016-01-20 15:53 ` [dpdk-dev] [PATCH 2/3] eal: add keepalive core register timestamp Harry van Haaren
2016-01-20 15:53 ` [dpdk-dev] [PATCH 3/3] keepalive: add rte_keepalive_xstats() and example Harry van Haaren
2016-01-21  9:57   ` Remy Horton
2016-01-21 11:05 ` [dpdk-dev] [PATCH v2 0/3] Keep-alive stats and doc fixes Harry van Haaren
2016-01-21 11:05   ` Harry van Haaren [this message]
2016-02-19 17:28     ` [dpdk-dev] [PATCH v2 1/3] doc: fix keepalive sample app guide Mcnamara, John
2016-01-21 11:05   ` [dpdk-dev] [PATCH v2 2/3] eal: add keepalive core register timestamp Harry van Haaren
2016-01-21 11:05   ` [dpdk-dev] [PATCH v2 3/3] keepalive: add rte_keepalive_xstats_get() and example Harry van Haaren
2016-01-21 12:12   ` [dpdk-dev] [PATCH v2 0/3] Keep-alive stats and doc fixes Remy Horton
2016-02-22 11:25   ` [dpdk-dev] [PATCH v3 0/3] Keepalive stats function " Harry van Haaren
2016-02-22 11:26     ` [dpdk-dev] [PATCH v3 1/3] doc: fix keepalive sample app guide Harry van Haaren
2016-02-22 16:54       ` Mcnamara, John
2016-02-22 11:26     ` [dpdk-dev] [PATCH v3 2/3] eal: add keepalive core register timestamp Harry van Haaren
2016-02-22 11:26     ` [dpdk-dev] [PATCH v3 3/3] keepalive: add rte_keepalive_xstats_get() Harry van Haaren
2016-02-29  9:19       ` Thomas Monjalon
2016-02-22 13:12     ` [dpdk-dev] [PATCH v3 0/3] Keepalive stats function and doc fixes Remy Horton
2016-03-08 10:50     ` [dpdk-dev] [PATCH v4 0/3] Keepalive register timestamp and doc update Harry van Haaren
2016-03-08 10:50       ` [dpdk-dev] [PATCH v4 1/3] doc: fix keepalive sample app guide Harry van Haaren
2016-03-08 10:50       ` [dpdk-dev] [PATCH v4 2/3] eal: add keepalive core register timestamp Harry van Haaren
2016-03-08 10:50       ` [dpdk-dev] [PATCH v4 3/3] keepalive: fix whitespace, removes double newlines Harry van Haaren
2016-03-08 10:58       ` [dpdk-dev] [PATCH v4 0/3] Keepalive register timestamp and doc update Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1453374327-26635-2-git-send-email-harry.van.haaren@intel.com \
    --to=harry.van.haaren@intel.com \
    --cc=dev@dpdk.org \
    --cc=remy.horton@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).