From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <jmcnam2x@ecsmtp.ir.intel.com>
Received: from mga02.intel.com (mga02.intel.com [134.134.136.20])
 by dpdk.org (Postfix) with ESMTP id A6C56C49E
 for <dev@dpdk.org>; Mon, 29 Jun 2015 15:42:38 +0200 (CEST)
Received: from fmsmga002.fm.intel.com ([10.253.24.26])
 by orsmga101.jf.intel.com with ESMTP; 29 Jun 2015 06:42:37 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.13,698,1427785200"; d="scan'208";a="752502633"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
 by fmsmga002.fm.intel.com with ESMTP; 29 Jun 2015 06:42:37 -0700
Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com
 [10.237.217.46])
 by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id
 t5TDgZZS017374; Mon, 29 Jun 2015 14:42:36 +0100
Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1])
 by sivswdev02.ir.intel.com with ESMTP id t5TDgZWX026729;
 Mon, 29 Jun 2015 14:42:35 +0100
Received: (from jmcnam2x@localhost)
 by sivswdev02.ir.intel.com with  id t5TDgZbB026725;
 Mon, 29 Jun 2015 14:42:35 +0100
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Date: Mon, 29 Jun 2015 14:42:23 +0100
Message-Id: <1435585344-26652-7-git-send-email-john.mcnamara@intel.com>
X-Mailer: git-send-email 1.7.4.1
In-Reply-To: <1435585344-26652-1-git-send-email-john.mcnamara@intel.com>
References: <1435585344-26652-1-git-send-email-john.mcnamara@intel.com>
Subject: [dpdk-dev] [PATCH v2 6/7] doc: document ieee1588 forwarding mode
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, 29 Jun 2015 13:42:39 -0000

Document the optional ieee1588 forwarding mode.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/testpmd_app_ug/run_app.rst       | 2 +-
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index b29c176..54ae2b2 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -315,7 +315,7 @@ They must be separated from the EAL options, shown in the previous section, with
 
 *   --forward-mode=N
 
-    Set forwarding mode. (N: io|mac|mac_retry|mac_swap|flowgen|rxonly|txonly|csum|icmpecho)
+    Set forwarding mode. (N: io|mac|mac_retry|mac_swap|flowgen|rxonly|txonly|csum|icmpecho|ieee1588)
 
 *   --rss-ip
 
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 761172e..8c55323 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -625,6 +625,8 @@ The available information categories are:
 
 *   icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
 
+*   ieee1588: demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
+
 
 Example:
 
-- 
1.8.1.4