From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <harry.van.haaren@intel.com>
Received: from mga03.intel.com (mga03.intel.com [134.134.136.65])
by dpdk.org (Postfix) with ESMTP id 6F6E6569C
for <dev@dpdk.org>; Mon, 22 Feb 2016 12:27:17 +0100 (CET)
Received: from fmsmga004.fm.intel.com ([10.253.24.48])
by orsmga103.jf.intel.com with ESMTP; 22 Feb 2016 03:26:47 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.22,484,1449561600"; d="scan'208";a="52390806"
Received: from sie-lab-212-120.ir.intel.com (HELO
silpixa00394367.ir.intel.com) ([10.237.212.120])
by fmsmga004.fm.intel.com with ESMTP; 22 Feb 2016 03:26:48 -0800
From: Harry van Haaren <harry.van.haaren@intel.com>
To: remy.horton@intel.com
Date: Mon, 22 Feb 2016 11:26:00 +0000
Message-Id: <1456140362-3771-2-git-send-email-harry.van.haaren@intel.com>
X-Mailer: git-send-email 2.5.0
In-Reply-To: <1456140362-3771-1-git-send-email-harry.van.haaren@intel.com>
References: <1453374327-26635-1-git-send-email-harry.van.haaren@intel.com>
<1456140362-3771-1-git-send-email-harry.van.haaren@intel.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v3 1/3] doc: fix keepalive sample app guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 22 Feb 2016 11:27:17 -0000
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