summaryrefslogtreecommitdiff
path: root/include/linux/mtd/ubi.h
diff options
context:
space:
mode:
authorDavid Wagner <david.wagner@free-electrons.com>2011-06-20 19:34:19 +0400
committerArtem Bityutskiy <dedekind1@gmail.com>2011-06-23 18:40:07 +0400
commit01dc9cc314ad1009f5b7356399b386015fdb0400 (patch)
treec3a61bf8a33db6285797374c1c43289569fbc7d2 /include/linux/mtd/ubi.h
parent4788b60a5faf9f9c9aec10fb7f6b36d9e0f9fa4c (diff)
downloadlinux-01dc9cc314ad1009f5b7356399b386015fdb0400.tar.xz
UBI: clarify the volume notification types' doc
I realized the new descriptions of ADDED and REMOVED could also be misleading: they can also be triggered after using a userland util (ubi{mk,rm}vol). Artem: amend the commentaries Signed-off-by David Wagner <david.wagner@free-electrons.com> Signed-off-by: Artem Bityutskiy <dedekind1@gmail.com>
Diffstat (limited to 'include/linux/mtd/ubi.h')
-rw-r--r--include/linux/mtd/ubi.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/include/linux/mtd/ubi.h b/include/linux/mtd/ubi.h
index 15da0e99f48a..db4836bed514 100644
--- a/include/linux/mtd/ubi.h
+++ b/include/linux/mtd/ubi.h
@@ -155,12 +155,14 @@ 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
+ * Volume notification types.
+ * @UBI_VOLUME_ADDED: a volume has been added (an UBI device was attached or a
+ * volume was created)
+ * @UBI_VOLUME_REMOVED: a volume has been removed (an UBI device was detached
+ * or a volume was removed)
+ * @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.