diskutil: Improve disk utilization data structure documentation

Document the meaning of the members of struct disk_util_stats.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>

diff --git a/diskutil.h b/diskutil.h
index 7d7ef802bfa1424530c333672a5b96223c12a48b..9dca42c42ebd9449df69aa823a9a9cfe4efd4661 100644 (file)
--- a/diskutil.h
+++ b/diskutil.h
@@ -7,6 +7,16 @@
 #include "helper_thread.h"
 #include "fio_sem.h"
 
+/**
+ * @ios: Number of I/O operations that have been completed successfully.
+ * @merges: Number of I/O operations that have been merged.
+ * @sectors: I/O size in 512-byte units.
+ * @ticks: Time spent on I/O in milliseconds.
+ * @io_ticks: CPU time spent on I/O in milliseconds.
+ * @time_in_queue: Weighted time spent doing I/O in milliseconds.
+ *
+ * For the array members, index 0 refers to reads and index 1 refers to writes.
+ */
 struct disk_util_stats {
        uint64_t ios[2];
        uint64_t merges[2];
@@ -18,7 +28,7 @@ struct disk_util_stats {
 };
 
 /*
- * Disk utils as read in /sys/block/<dev>/stat
+ * Disk utilization as read from /sys/block/<dev>/stat
  */
 struct disk_util_stat {
        uint8_t name[FIO_DU_NAME_SZ];