Patchwork UBI: clarify the volume notification types' doc

login
register
mail settings
Submitter David Wagner
Date June 20, 2011, 9:27 a.m.
Message ID <4DFF129E.6070808@free-electrons.com>
Download mbox | patch
Permalink /patch/101063/
State New
Headers show

Comments

David Wagner - June 20, 2011, 9:27 a.m.
I found the UBI_VOLUME_REMOVED inline documentation not to be clear.
This patch fixes it and tweaks the documentation of the other
notification types.

Signed-off-by David Wagner <david.wagner@free-electrons.com>
---
 include/linux/mtd/ubi.h |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)

Patch

diff --git a/include/linux/mtd/ubi.h b/include/linux/mtd/ubi.h
index b31bd9e..ddc453f 100644
--- a/include/linux/mtd/ubi.h
+++ b/include/linux/mtd/ubi.h
@@ -134,11 +134,11 @@  struct ubi_device_info {

 /*
  * enum - volume notification types.
- * @UBI_VOLUME_ADDED: volume has been added
- * @UBI_VOLUME_REMOVED: start volume volume
- * @UBI_VOLUME_RESIZED: volume size has been re-sized
- * @UBI_VOLUME_RENAMED: volume name has been re-named
- * @UBI_VOLUME_UPDATED: volume name has been updated
+ * @UBI_VOLUME_ADDED: a volume has been added (attached)
+ * @UBI_VOLUME_REMOVED: a volume has been removed (detached)
+ * @UBI_VOLUME_RESIZED: a volume has been re-sized
+ * @UBI_VOLUME_RENAMED: a volume has been re-named
+ * @UBI_VOLUME_UPDATED: data has been written to a volume
  *
  * These constants define which type of event has happened when a volume
  * notification function is invoked.