ostree_deployment_hash ()

guint
ostree_deployment_hash (gconstpointer v);

ostree_deployment_equal ()

gboolean
ostree_deployment_equal (gconstpointer ap,
                         gconstpointer bp);

ostree_deployment_new ()

OstreeDeployment *
ostree_deployment_new (int index,
                       const char *osname,
                       const char *csum,
                       int deployserial,
                       const char *bootcsum,
                       int bootserial);

ostree_deployment_get_index ()

int
ostree_deployment_get_index (OstreeDeployment *self);

ostree_deployment_get_osname ()

const char *
ostree_deployment_get_osname (OstreeDeployment *self);

ostree_deployment_get_deployserial ()

int
ostree_deployment_get_deployserial (OstreeDeployment *self);

ostree_deployment_get_csum ()

const char *
ostree_deployment_get_csum (OstreeDeployment *self);

ostree_deployment_get_bootcsum ()

const char *
ostree_deployment_get_bootcsum (OstreeDeployment *self);

ostree_deployment_get_bootserial ()

int
ostree_deployment_get_bootserial (OstreeDeployment *self);

ostree_deployment_get_bootconfig ()

OstreeBootconfigParser *
ostree_deployment_get_bootconfig (OstreeDeployment *self);

ostree_deployment_get_origin ()

GKeyFile *
ostree_deployment_get_origin (OstreeDeployment *self);

ostree_deployment_get_origin_relpath ()

char *
ostree_deployment_get_origin_relpath (OstreeDeployment *self);

Note this function only returns a *relative* path - if you want to access, it, you must either use fd-relative api such as openat(), or concatenate it with the full ostree_sysroot_get_path().

ostree_deployment_get_unlocked ()

OstreeDeploymentUnlockedState
ostree_deployment_get_unlocked (OstreeDeployment *self);

Since: 2016.4

ostree_deployment_is_pinned ()

gboolean
ostree_deployment_is_pinned (OstreeDeployment *self);

See ostree_sysroot_deployment_set_pinned().

Since: 2018.3

ostree_deployment_is_staged ()

gboolean
ostree_deployment_is_staged (OstreeDeployment *self);

Since: 2018.3

ostree_deployment_is_finalization_locked ()

gboolean
ostree_deployment_is_finalization_locked
                               (OstreeDeployment *self);

Since: 2023.8

ostree_deployment_set_index ()

void
ostree_deployment_set_index (OstreeDeployment *self,
                             int index);

Sets the global index into the bootloader ordering.

ostree_deployment_set_bootserial ()

void
ostree_deployment_set_bootserial (OstreeDeployment *self,
                                  int index);

Should never have been made public API; don't use this.

ostree_deployment_set_bootconfig ()

void
ostree_deployment_set_bootconfig (OstreeDeployment *self,
                                  OstreeBootconfigParser *bootconfig);

Set or clear the bootloader configuration.

ostree_deployment_set_origin ()

void
ostree_deployment_set_origin (OstreeDeployment *self,
                              GKeyFile *origin);

Replace the "origin", which is a description of the source of the deployment and how to update to the next version.

ostree_deployment_origin_remove_transient_state ()

void
ostree_deployment_origin_remove_transient_state
                               (GKeyFile *origin);

The intention of an origin file is primarily describe the "inputs" that resulted in a deployment, and it's commonly used to derive the new state. For example, a key value (in pure libostree mode) is the "refspec". However, libostree (or other applications) may want to store "transient" state that should not be carried across upgrades.

This function just removes all members of the libostree-transient group. The name of that group is available to all libostree users; best practice would be to prefix values underneath there with a short identifier for your software.

Additionally, this function will remove the origin/unlocked and origin/override-commit members; these should be considered transient state that should have been under an explicit group.

Since: 2018.3

ostree_deployment_clone ()

OstreeDeployment *
ostree_deployment_clone (OstreeDeployment *self);

ostree_deployment_unlocked_state_to_string ()

const char *
ostree_deployment_unlocked_state_to_string
                               (OstreeDeploymentUnlockedState state);

Since: 2016.4

OstreeDeployment

typedef struct {
  GObject parent_instance;

  int index;
  char *osname;
  char *csum;
  int deployserial;
  char *bootcsum;
  int bootserial;
  OstreeBootconfigParser *bootconfig;
  GKeyFile *origin;
  OstreeDeploymentUnlockedState unlocked;
  gboolean staged;
  gboolean finalization_locked;
  char **overlay_initrds;
  char *overlay_initrds_id;
} OstreeDeployment;