UBI: clarify the volume notification types' doc
Subsystems (2)
PATCH 1/1 UBI: clarify the volume notification types' doc
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 <[email protected]>
--- include/linux/mtd/ubi.h | 10 +++++----- 1 files changed, 5 insertions(+), 5 deletions(-)
include/linux/mtd/ubi.h +5 -5
@@ -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.
Signature · 7 lines
1.7.0.4 -- David Wagner, Free Electrons Kernel, drivers, real-time and embedded Linux development, consulting, training and support. http://free-electrons.com
PATCH v2 1/1 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).
(the indentation looks odd but is fine once the patch has been applied)
Signed-off-by David Wagner <[email protected]>
--- include/linux/mtd/ubi.h | 12 +++++++----- 1 files changed, 7 insertions(+), 5 deletions(-)
include/linux/mtd/ubi.h +3 -5
@@ -134,11 +134,13 @@ 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 (containing device attached +* or volume created from a userland util) +* @UBI_VOLUME_REMOVED: a volume has been removed (containing device
detached
+ * or volume created from a userland util)
+ * @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.
Signature · 11 lines
1.7.0.4 -- David Wagner, Free Electrons Kernel, drivers, real-time and embedded Linux development, consulting, training and support. http://free-electrons.com ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
Quoted 27 lines · David Wagner
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).(the indentation looks odd but is fine once the patch has been applied)
Signed-off-by David Wagner <[email protected]>
--- include/linux/mtd/ubi.h | 12 +++++++----- 1 files changed, 7 insertions(+), 5 deletions(-)include/linux/mtd/ubi.h +3
-5@@ -134,11 +134,13 @@ 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 (containing device attached +* or volume created from a userland util) +* @UBI_VOLUME_REMOVED: a volume has been removed (containing device
Quoted 1 line
detached
The patch is corrupted because of line-wrapping, but I fixed it and amended the comments a bit (did not like the "userland util" phrase), and pushed to ubi-2.6.git tree, thanks.
Signature · 2 lines
Best Regards, Artem Bityutskiy