From patchwork Fri Jun 30 16:51:27 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 26118 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 1CCB37CB0; Fri, 30 Jun 2017 18:52:23 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 8E9865587 for ; Fri, 30 Jun 2017 18:52:03 +0200 (CEST) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 30 Jun 2017 09:51:58 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,287,1496127600"; d="scan'208";a="103233215" Received: from silpixa00372839.ir.intel.com (HELO silpixa00372839.ger.corp.intel.com) ([10.237.222.154]) by orsmga004.jf.intel.com with ESMTP; 30 Jun 2017 09:51:53 -0700 From: Ferruh Yigit To: dev@dpdk.org Cc: Ferruh Yigit , Stephen Hemminger , Bruce Richardson , Anatoly Burakov Date: Fri, 30 Jun 2017 17:51:27 +0100 Message-Id: <20170630165140.59594-8-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.13.0 In-Reply-To: <20170630165140.59594-1-ferruh.yigit@intel.com> References: <20170621110651.75299-1-ferruh.yigit@intel.com> <20170630165140.59594-1-ferruh.yigit@intel.com> Subject: [dpdk-dev] [PATCH v9 07/20] doc: update ethtool sample app doc X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Ferruh Yigit Acked-by: John McNamara --- doc/guides/sample_app_ug/ethtool.rst | 36 ++++-------------------------------- 1 file changed, 4 insertions(+), 32 deletions(-) diff --git a/doc/guides/sample_app_ug/ethtool.rst b/doc/guides/sample_app_ug/ethtool.rst index 67797954d..def48985d 100644 --- a/doc/guides/sample_app_ug/ethtool.rst +++ b/doc/guides/sample_app_ug/ethtool.rst @@ -1,6 +1,6 @@ .. BSD LICENSE - Copyright(c) 2015 Intel Corporation. All rights reserved. + Copyright(c) 2015-2017 Intel Corporation. All rights reserved. All rights reserved. Redistribution and use in source and binary forms, with or without @@ -71,7 +71,7 @@ The only available options are the standard ones for the EAL: .. code-block:: console - ./ethtool-app/ethtool-app/${RTE_TARGET}/ethtool [EAL options] + ./${RTE_TARGET}/ethtool [EAL options] Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) @@ -128,33 +128,5 @@ Ethtool Shell The foreground part of the Ethtool sample is a console-based interface that accepts commands as described in `using the application`_. Individual call-back functions handle the detail -associated with each command, which make use of the functions -defined in the `Ethtool interface`_ to the DPDK functions. - -Ethtool interface ------------------ - -The Ethtool interface is built as a separate library, and implements -the following functions: - -- ``rte_ethtool_get_drvinfo()`` -- ``rte_ethtool_get_regs_len()`` -- ``rte_ethtool_get_regs()`` -- ``rte_ethtool_get_link()`` -- ``rte_ethtool_get_eeprom_len()`` -- ``rte_ethtool_get_eeprom()`` -- ``rte_ethtool_set_eeprom()`` -- ``rte_ethtool_get_pauseparam()`` -- ``rte_ethtool_set_pauseparam()`` -- ``rte_ethtool_net_open()`` -- ``rte_ethtool_net_stop()`` -- ``rte_ethtool_net_get_mac_addr()`` -- ``rte_ethtool_net_set_mac_addr()`` -- ``rte_ethtool_net_validate_addr()`` -- ``rte_ethtool_net_change_mtu()`` -- ``rte_ethtool_net_get_stats64()`` -- ``rte_ethtool_net_vlan_rx_add_vid()`` -- ``rte_ethtool_net_vlan_rx_kill_vid()`` -- ``rte_ethtool_net_set_rx_mode()`` -- ``rte_ethtool_get_ringparam()`` -- ``rte_ethtool_set_ringparam()`` +associated with each command, which make use of librte_ethtool +library.