Patchwork [4/4] block_int.h: Provide documentation for common block qdev properties

login
register
mail settings
Submitter Amit Shah
Date Sept. 15, 2010, 12:36 p.m.
Message ID <7be6d56c6e6366c513e8ddd94dd9c7f0103395ec.1284553514.git.amit.shah@redhat.com>
Download mbox | patch
Permalink /patch/64809/
State New
Headers show

Comments

Amit Shah - Sept. 15, 2010, 12:36 p.m.
Document the options common to all block devices.

This comes from Kevin.

Signed-off-by: Amit Shah <amit.shah@redhat.com>
CC: Kevin Wolf <kwolf@redhat.com>
---
 block_int.h |   14 ++++++++------
 1 files changed, 8 insertions(+), 6 deletions(-)

Patch

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 */