From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id B0CCD3257 for ; Tue, 16 Jan 2018 11:34:50 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 5979720C7E; Tue, 16 Jan 2018 05:34:50 -0500 (EST) Received: from frontend2 ([10.202.2.161]) by compute1.internal (MEProxy); Tue, 16 Jan 2018 05:34:50 -0500 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=0AZzvvBPTFzhhzyHeF7KO2byz7 KxYLszlVVZ9XgR5Ws=; b=Vj3SEVmhSDdf7Ljp3U11Vo0uURahJS7X6P3+s1haYh bob6x5R28U2lUR74nxv0uKt/4SYROTzUrW2Z1dumDLwXLKvC2FCMT908bwnVEXyp 5tVnxd+h4edfxTMvlIk5gfkz8NnNVhyDZ0wWosRpRq8g9JAGGlAbYRSHwRbPEwE6 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=0AZzvv BPTFzhhzyHeF7KO2byz7KxYLszlVVZ9XgR5Ws=; b=ODNf3QXnTiFNAuYgWsCOV8 H7TeLcx9/Y9DG71h1+mosGxGZWx+/uEZXFLnhv6pE9NgYdJ9W5aIUU1uwu5jolns fmzHSTfwhGmKr4ca+fr/Do8JYqkGL+xRs4cCps2+yto7Du7vmjZCmLx4EXabj+vh pQO+UyTUN+0u6LhGfhdmqa4mq+eNgDpWqDDQBNmUSeQolO4jA/WGj2rovlWmWisJ dbWpppd3GtyhMdKe4ACMKdb6+l0Zqtn+m2nz5eqkTPPX6PuzmhNHgorX/LCl/ZQ+ hQaf/0LBiL7AlV228lpA1JOZGHHkYz3c1X3YvMzK/QcKwTDldljqFSaYCbiuUVvA == 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 0276B24235; Tue, 16 Jan 2018 05:34:50 -0500 (EST) From: Thomas Monjalon To: Shreyansh Jain Cc: dev@dpdk.org, hemant.agrawal@nxp.com, fiona.trahe@intel.com, rosen.xu@intel.com Date: Tue, 16 Jan 2018 11:34:18 +0100 Message-ID: <11422063.ykzEjuYYhU@xps> In-Reply-To: References: <20180102125749.2379-1-shreyansh.jain@nxp.com> <3616426.fmUHyIAH1S@xps> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v1 3/5] drivers/raw: introduce skeleton rawdev driver 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: Tue, 16 Jan 2018 10:34:51 -0000 16/01/2018 11:21, Shreyansh Jain: > On Monday 15 January 2018 04:24 AM, Thomas Monjalon wrote: > > 02/01/2018 13:57, Shreyansh Jain: > >> +struct skeleton_firmware { > >> + struct skeleton_firmware_version_info firmware_version; > >> + /**< Device firmware information */ > >> + enum skeleton_firmware_state firmware_state; > >> + /**< Device state */ > >> +}; > >> + > >> +#define SKELETON_MAX_ATTRIBUTES 10 > >> +#define SKELETON_ATTRIBUTE_NAME_MAX 20 > >> + > >> +struct skeleton_rawdev_attributes { > >> + char *name; > >> + /**< Name of the attribute */ > >> + uint64_t value; > >> + /**< Value or reference of value of attribute */ > >> +}; > >> + > >> +#define SKELETON_CAPA_FW_LOAD 0x0001 > >> +/**< Device supports firmware loading/unloading */ > >> +#define SKELETON_CAPA_FW_RESET 0x0002 > >> +/**< Device supports firmware reset */ > >> +#define SKELETON_CAPA_QUEUES 0x0004 > >> +/**< Device support queue based communication */ > > > > Comment about the style. The style is important :) > > You are always writing comments after the item. > > Yes, I was trying to stick to single method - postfix. > > > When comments are on a separate line, I think it is preferred to write > > them *before* the item they describe. > > > > Consider this: > > struct dummy { > int a; /**< a postfix comment */ > /**< a prefix comment */ > int b; > }; > > Personally, Even I prefer prefix when it comes to full line comments - > but mixing prefix and postfix can lead to non-readable code. > > Anyways - I was referring [1] > > [1] > http://dpdk.org/doc/guides/contributing/documentation.html#doxygen-guidelines > > and it seems that I should change all to prefix in case any comment in > the structure is not fitting into a single line. > I will do that. OK thanks