[v2,3/5] block/block: Document BlockSizes fields

Commit Message

Philippe Mathieu-Daudé May 15, 2020, 9:19 a.m. UTC

As it is not obvious for a block neophyte what means
the 'log' value, document it.

Reviewed-by: Stefan Hajnoczi <[e-mail]>
Signed-off-by: Philippe Mathieu-Daudé <[e-mail]>
---
 include/block/block.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Patch

diff --git a/include/block/block.h b/include/block/block.h
index 480e6b6837..6836876da1 100644
--- a/include/block/block.h
+++ b/include/block/block.h
@@ -86,8 +86,8 @@  typedef enum {
 } BdrvRequestFlags;
 
 typedef struct BlockSizes {
-    uint32_t phys;
-    uint32_t log;
+    uint32_t phys;  /* physical block size */
+    uint32_t log;   /* logical block size */
 } BlockSizes;
 
 typedef struct HDGeometry {