diff mbox series

state: Update code comments on persistent state handling

Message ID 20210126111744.10844-1-christian.storm@siemens.com
State Accepted
Headers show
Series state: Update code comments on persistent state handling | expand

Commit Message

Christian Storm Jan. 26, 2021, 11:17 a.m. UTC
Signed-off-by: Christian Storm <christian.storm@siemens.com>
---
 include/state.h | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)

Comments

Stefano Babic Jan. 26, 2021, 11:56 a.m. UTC | #1
On 26.01.21 12:17, Christian Storm wrote:
> Signed-off-by: Christian Storm <christian.storm@siemens.com>
> ---
>  include/state.h | 15 +++++----------
>  1 file changed, 5 insertions(+), 10 deletions(-)
> 
> diff --git a/include/state.h b/include/state.h
> index c0f1175..4ddb607 100644
> --- a/include/state.h
> +++ b/include/state.h
> @@ -19,17 +19,12 @@
>  
>  /* (Persistent) Update State Management Functions.
>   *
> - * Suricatta may persistently store the update status to communicate it to the
> - * server instance after, e.g., a successful reboot into the new firmware. The
> - * `{save,read,reset}_state()` functions are called by a server implementation
> - * to persistently manage the update state via, e.g., U-Boot's environment.
> + * The SWUpdate core or a module such as suricatta may want to persistently
> + * store the update status to communicate it to the server instance after,
> + * e.g., a successful reboot into the new firmware.
> + * The `{save,get}_state()` functions are called to manage the update status
> + * via, e.g., U-Boot's environment.
>   *
> - * Besides suricatta, this mechanism is also used by SWUpdate's core for
> - * setting an update transaction marker, i.e., the bootloader environment
> - * variable BOOTVAR_TRANSACTION (default: "recovery_status") is set to
> - * "in_progress" prior to an update operation and either unset or set to
> - * "failed" after the update operation, depending on whether an sw-description's
> - * "bootloader_transaction_marker" property is true which is the default.
>   */
>  
>  typedef enum {
> 

Reviewed-by: Stefano Babic <sbabic@denx.de>

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/include/state.h b/include/state.h
index c0f1175..4ddb607 100644
--- a/include/state.h
+++ b/include/state.h
@@ -19,17 +19,12 @@ 
 
 /* (Persistent) Update State Management Functions.
  *
- * Suricatta may persistently store the update status to communicate it to the
- * server instance after, e.g., a successful reboot into the new firmware. The
- * `{save,read,reset}_state()` functions are called by a server implementation
- * to persistently manage the update state via, e.g., U-Boot's environment.
+ * The SWUpdate core or a module such as suricatta may want to persistently
+ * store the update status to communicate it to the server instance after,
+ * e.g., a successful reboot into the new firmware.
+ * The `{save,get}_state()` functions are called to manage the update status
+ * via, e.g., U-Boot's environment.
  *
- * Besides suricatta, this mechanism is also used by SWUpdate's core for
- * setting an update transaction marker, i.e., the bootloader environment
- * variable BOOTVAR_TRANSACTION (default: "recovery_status") is set to
- * "in_progress" prior to an update operation and either unset or set to
- * "failed" after the update operation, depending on whether an sw-description's
- * "bootloader_transaction_marker" property is true which is the default.
  */
 
 typedef enum {