From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id 032FC1B6D0 for ; Tue, 24 Oct 2017 00:11:14 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 587A920DEA; Mon, 23 Oct 2017 18:11:14 -0400 (EDT) Received: from frontend1 ([10.202.2.160]) by compute1.internal (MEProxy); Mon, 23 Oct 2017 18:11:14 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc; s=mesmtp; bh=xIdZHip4cEB8lJRbCXtApchvQ5 jopfObozyVd6pCojA=; b=d011shAfedc4wp3Nh3PlBKp9j+fUf8VAihJAk2qgyo ggCTmzHMUKy7KJWqiv0soKtgoQuLEezXUas9crQkc101kOuOVBG6nN0x76TAI8S5 Yet4O7RZyDB5c1EHiqgrA2qSwo88ZmE5jeCkC1ot1NGiG3w8FUX9VFFhDqwsTnye w= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=xIdZHi p4cEB8lJRbCXtApchvQ5jopfObozyVd6pCojA=; b=U0MWaH4u+fQNxhkkBWAL2+ CCmNPu2BB1tZTxRIPphj0XqH8SybamvQVqV+KXiYUPny8LF6RW0QpBcNGHC1PM06 c7AQ9wKabBVoPw92g/FUhj5dPtA+avF9ronF7nY5q8EEY+gc53vUbbj2q1bnwjZA 5FXWguGnMz/I2m8qVXx6/bjnkh3vjbHjPBqvIl2UlNg4oBVksbINcr8rXL1jGBeF 5/d8/Vx+jjIX52MoTYET72LrAjM7adx7XVglYT+U5Kbyx4jv8peu6ie1lSL50Pn2 7w+qAUhy7udEZs0l9Cmh8uQaIy3qaxe7wiCzeHLunbQ1fGohr+N8n9bI5ro2okUQ == X-ME-Sender: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 05DAC7F967; Mon, 23 Oct 2017 18:11:14 -0400 (EDT) From: Thomas Monjalon To: Remy Horton , luca.boccassi@gmail.com, Luca Boccassi Cc: dev@dpdk.org, wenzhuo.lu@intel.com, wei.dai@intel.com Date: Tue, 24 Oct 2017 00:11:13 +0200 Message-ID: <3757028.oCNDDIN3Jm@xps> In-Reply-To: References: <20171019134827.22740-1-luca.boccassi@gmail.com> <20171019134827.22740-2-luca.boccassi@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH 2/2] ethdev: pre-emptively document rte_eth_dev_reset error code 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: , X-List-Received-Date: Mon, 23 Oct 2017 22:11:15 -0000 19/10/2017 16:53, Remy Horton: > > On 19/10/2017 14:48, luca.boccassi@gmail.com wrote: > > Document it immediately even if it's not yet supported, so that users > > and developers can already take into account about this use case, and > > thus avoid an API-incompatible change later on. > > I'm not sure about documenting unimplemented features, as API docs ought > to describe what the code currently does. Then again reason seems OK and > I don't think there's hard guidelines on this.. An API does not need to be implemented to describe its behaviour. We just have to agree about which behaviour we want to expect. It seems this error code is reasonable. But I am not sure you need to give the details about the cause of the error. The most important is to advise app writer to retry resetting later when the device is ready. Isn't it?