From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=54150 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OvrEk-0007L9-3q for qemu-devel@nongnu.org; Wed, 15 Sep 2010 08:37:25 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OvrEh-0004pT-45 for qemu-devel@nongnu.org; Wed, 15 Sep 2010 08:37:17 -0400 Received: from mx1.redhat.com ([209.132.183.28]:61466) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OvrEg-0004pH-U7 for qemu-devel@nongnu.org; Wed, 15 Sep 2010 08:37:15 -0400 From: Amit Shah Date: Wed, 15 Sep 2010 18:06:52 +0530 Message-Id: <7be6d56c6e6366c513e8ddd94dd9c7f0103395ec.1284553514.git.amit.shah@redhat.com> In-Reply-To: References: In-Reply-To: References: Subject: [Qemu-devel] [PATCH 4/4] block_int.h: Provide documentation for common block qdev properties List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Anthony Liguori Cc: Amit Shah , Kevin Wolf , qemu list Document the options common to all block devices. This comes from Kevin. Signed-off-by: Amit Shah CC: Kevin Wolf --- block_int.h | 14 ++++++++------ 1 files changed, 8 insertions(+), 6 deletions(-) diff --git a/block_int.h b/block_int.h index ce20285..06e894d 100644 --- a/block_int.h +++ b/block_int.h @@ -241,12 +241,14 @@ static inline unsigned int get_physical_block_exp(BlockConf *conf) } #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \ - DEFINE_PROP_DRIVE("drive", _state, _conf.bs, ""), \ - DEFINE_PROP_UINT16("logical_block_size", _state, \ - _conf.logical_block_size, 512, ""), \ + DEFINE_PROP_DRIVE("drive", _state, _conf.bs, "The host drive details, specified by the -drive parameter"), \ + DEFINE_PROP_UINT16("logical_block_size", _state, _conf.logical_block_size, \ + 512, "Logical sector size of the disk"), \ 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, "") + _conf.physical_block_size, 512, "Physical sector size of the disk"), \ + DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0, \ + "Minimal size for IO requests in bytes. Must be a power of two that is 512 or greater."), \ + DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0, \ + "Size for IO requests that provides optimal performance (in bytes). Must be a power of two that is 512 or greater.") #endif /* BLOCK_INT_H */ -- 1.7.2.2