Document the options common to all block devices.
This comes from Kevin.
Signed-off-by: Amit Shah <amit.s...@redhat.com>
CC: Kevin Wolf <kw...@redhat.com>
---
block_int.h | 20 ++++++++++++--------
1 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/block_int.h b/block_int.h
index 8b0341c..2488eeb 100644
--- a/block_int.h
+++ b/block_int.h
@@ -247,15 +247,19 @@ 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, ""), \
- DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1, ""), \
+ _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."), \
+ DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1, \
+ "The index this device will be tried to boot from"), \
DEFINE_PROP_UINT32("discard_granularity", _state, \
- _conf.discard_granularity, 0, "")
+ _conf.discard_granularity, 0, \
+ "Number of free sectors needed to discard free blocks
in a mapping image")
#endif /* BLOCK_INT_H */
--
1.7.3.4
