libhardware: boot_control: Clarify documentation for isSlotBootable().

The documentation for this method is clearly wrong and it confused
several implementors.

Change-Id: I0427abcf87d0c8955ea1168513e6b9ab85380bf2

1 files changed, 5 insertions, 4 deletions

diff --git a/include/hardware/boot_control.h b/include/hardware/boot_control.h
index 62d6918e..7a6a8498 100644
--- a/include/hardware/boot_control.h
+++ b/include/hardware/boot_control.h
@@ -101,10 +101,11 @@ typedef struct boot_control_module {
     int (*setSlotAsUnbootable)(struct boot_control_module *module, unsigned slot);
 
     /*
-     * (*isSlotBootable)() returns if the slot passed in parameter has
-     * booted successfully in the past.
-     * Returns 1 if the slot has booted successfully, 0 if it has not,
-     * and -errno on error.
+     * (*isSlotBootable)() returns if the slot passed in parameter is
+     * bootable. Note that slots can be made unbootable by both the
+     * bootloader and by the OS using setSlotAsUnbootable.
+     * Returns 1 if the slot is bootable, 0 if it's not, and -errno on
+     * error.
      */
     int (*isSlotBootable)(struct boot_control_module *module, unsigned slot);