From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=53941 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Pq3fR-0006vp-Ds for qemu-devel@nongnu.org; Thu, 17 Feb 2011 08:13:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Pq3fO-00068s-FY for qemu-devel@nongnu.org; Thu, 17 Feb 2011 08:13:08 -0500 Received: from mail-vx0-f173.google.com ([209.85.220.173]:44010) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Pq3fO-00068o-DB for qemu-devel@nongnu.org; Thu, 17 Feb 2011 08:13:06 -0500 Received: by vxb40 with SMTP id 40so1128728vxb.4 for ; Thu, 17 Feb 2011 05:13:06 -0800 (PST) Message-ID: <4D5D1ECA.1060901@codemonkey.ws> Date: Thu, 17 Feb 2011 07:12:42 -0600 From: Anthony Liguori MIME-Version: 1.0 Subject: Re: [Qemu-devel] [PATCH REBASE/RESEND 1/4] qdev: Add a description field for qdev properties for documentation References: <4D5AAD3E.6010201@codemonkey.ws> <20110217130657.GD27487@amit-x200.redhat.com> In-Reply-To: <20110217130657.GD27487@amit-x200.redhat.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Amit Shah Cc: qemu list , Markus Armbruster On 02/17/2011 07:06 AM, Amit Shah wrote: > On (Tue) 15 Feb 2011 [10:43:42], Anthony Liguori wrote: > > >>> #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \ >>> - DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \ >>> + DEFINE_PROP_DRIVE("drive", _state, _conf.bs, ""), \ >>> DEFINE_PROP_UINT16("logical_block_size", _state, \ >>> - _conf.logical_block_size, 512), \ >>> + _conf.logical_block_size, 512, ""), \ >>> DEFINE_PROP_UINT16("physical_block_size", _state, \ >>> - _conf.physical_block_size, 512), \ >>> - DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \ >>> - DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \ >>> - DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \ >>> + _conf.physical_block_size, 512, ""), \ >>> + DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0, ""), \ >>> + DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0, ""), \ >>> + DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1, ""), \ >>> DEFINE_PROP_UINT32("discard_granularity", _state, \ >>> - _conf.discard_granularity, 0) >>> + _conf.discard_granularity, 0, "") >>> >> This is pretty horribly ugly. If we were going this, we should at >> least introduce new defines that include a documentation field and >> not just add empty documentation fields. >> > We've discussed this in the past. Once this patch series gets in, > I'll work to fill in the documentation here along with the > maintainers. > It means you're touching everything twice instead of touching everything once. That's unnecessary churn and blame breakage. It's still just as greppable if you use a new name. Regards, Anthony Liguori > Also, an empty string is a reminder to people to add something here. > > Amit > >