From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f41.google.com (mail-wm0-f41.google.com [74.125.82.41]) by dpdk.org (Postfix) with ESMTP id E6D2B2BE3 for ; Wed, 9 Mar 2016 00:36:49 +0100 (CET) Received: by mail-wm0-f41.google.com with SMTP id l68so170694338wml.0 for ; Tue, 08 Mar 2016 15:36:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:organization:user-agent :in-reply-to:references:mime-version:content-transfer-encoding; bh=fLEh9rkfdQYIyON94PUaAzvSCMT0pnViEO8fzZZI/8E=; b=mcnq04pESjP8J/bRe/AU29ur/fykoS8Sdfbct6/nHuDBbp/0muwmpcVBveNCsOeSEb TvTmKe8sJFl90hCC+tkE8KkeZKABoXJLREyfeqb9us6R6v/r8USvn5KAGlAOd4t4Pgbi 7oMWJJ3qI3FUrDcaMYuZ1ERw973kgBEVBrXtxk5nHjrFZXkKr+Yon3/BHxCXUXQQhSwL K9qayjR9olSqBgsfAhghpPZBm9EMJ9jbNwTh6MmAR+ZAM7kvbWzD0m8uU6x9wWHMkgC4 Zb6Ypekk9jvVCKVgtZVuCtw6P6jqBbLjT5MVSB/ViYwTMrXP1pJrdpYW/7Uks66ROTKU dWrg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:organization :user-agent:in-reply-to:references:mime-version :content-transfer-encoding; bh=fLEh9rkfdQYIyON94PUaAzvSCMT0pnViEO8fzZZI/8E=; b=KR0NmKdIbULvGScltI4PK9fRQPj7O+1qvx5ucQMh205DX5xhjP91bSKRXtnp7QVxOO PQQkle0m5vhgi/Ust/VXI3apdSWK1TeV7NPbLm1BqQNmjTWbvM/pPu3fRoMcol7Wgblg Xm1UfRaaTWEoEYx6GMaR3WK22vMC2MapEzzCD7A7fnvH8+CcvRx7rXLjYe92WygRfsxd VyrNUDOA0a6/iDiJgfefU8Jy4Ls2cwTB6xWdhtDg8X7gHGk0tMfWReP6c2sYtf5PWJ7f RAwuJKwbYAwLNqqcWNgvHgGu4Ebr2+mSu7d2baInPPTh8y1P5GmyWq7hxtDHn42AsO5o 8S8A== X-Gm-Message-State: AD7BkJLCQ1qekQU18EUJSJIqdpmGJZQE/R3xwP/xg3CHbn7qbPYHzEFitbatQ3xHXGSa0B7a X-Received: by 10.28.24.130 with SMTP id 124mr22913890wmy.50.1457480209754; Tue, 08 Mar 2016 15:36:49 -0800 (PST) Received: from xps13.localnet (171.36.101.84.rev.sfr.net. [84.101.36.171]) by smtp.gmail.com with ESMTPSA id i5sm5166121wjx.15.2016.03.08.15.36.48 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 08 Mar 2016 15:36:48 -0800 (PST) From: Thomas Monjalon To: Wenzhuo Lu Date: Wed, 09 Mar 2016 00:35:10 +0100 Message-ID: <1916349.pcHeyTKjoM@xps13> Organization: 6WIND User-Agent: KMail/4.14.10 (Linux/4.1.6-1-ARCH; KDE/4.14.11; x86_64; ; ) In-Reply-To: <1457058915-9439-2-git-send-email-wenzhuo.lu@intel.com> References: <1452496044-17524-1-git-send-email-wenzhuo.lu@intel.com> <1457058915-9439-1-git-send-email-wenzhuo.lu@intel.com> <1457058915-9439-2-git-send-email-wenzhuo.lu@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH v7 1/5] lib/librte_ether: change function name of tunnel port config X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 08 Mar 2016 23:36:50 -0000 2016-03-04 10:35, Wenzhuo Lu: > The names of function for tunnel port configuration are not > accurate. They're tunnel_add/del, better change them to > tunnel_port_add/del. As a lot of ethdev API, it is really badly documented. Please explain why this renaming and let's try to reword the doxygen: * Add UDP tunneling port of an Ethernet device for filtering a specific * tunneling packet by UDP port number. Please what are the values of struct rte_eth_udp_tunnel { uint16_t udp_port; uint8_t prot_type; }; When I see an API struct without any comment, I feel it must be dropped. By the way, it is yet another filtering API, so it must be totally reworked. > As it may be an ABI change if change the names directly, the > new functions are added but not remove the old ones. The old > ones will be removed in the next release after an ABI change > announcement. Please make the announce in this patch. > --- a/lib/librte_ether/rte_ethdev.h > +++ b/lib/librte_ether/rte_ethdev.h > @@ -3403,6 +3415,9 @@ rte_eth_dev_rss_hash_conf_get(uint8_t port_id, > int > rte_eth_dev_udp_tunnel_add(uint8_t port_id, > struct rte_eth_udp_tunnel *tunnel_udp); You must deprecate this one and put a comment above with something like @see rte_eth_dev_udp_tunnel_port_add. > +int > +rte_eth_dev_udp_tunnel_port_add(uint8_t port_id, > + struct rte_eth_udp_tunnel *tunnel_udp); You must move it below the doxygen comment. > > /** > * Detete UDP tunneling port configuration of Ethernet device > @@ -3420,6 +3435,9 @@ rte_eth_dev_udp_tunnel_add(uint8_t port_id, > int > rte_eth_dev_udp_tunnel_delete(uint8_t port_id, > struct rte_eth_udp_tunnel *tunnel_udp); > +int > +rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id, > + struct rte_eth_udp_tunnel *tunnel_udp); idem > --- a/lib/librte_ether/rte_ether_version.map > +++ b/lib/librte_ether/rte_ether_version.map > @@ -114,6 +114,8 @@ DPDK_2.2 { > rte_eth_tx_queue_setup; > rte_eth_xstats_get; > rte_eth_xstats_reset; > + rte_eth_dev_udp_tunnel_port_add; > + rte_eth_dev_udp_tunnel_port_delete; > > local: *; > }; Panu already made a comment about adding a new section for 16.04.