ostree-deployment

ostree-deployment

Functions

Types and Values

Description

Functions

ostree_deployment_hash ()

guint
ostree_deployment_hash (gconstpointer v);

ostree_deployment_equal ()

gboolean
ostree_deployment_equal (gconstpointer ap,
                         gconstpointer bp);

Parameters

ap

A deployment.

[type OstreeDeployment]

bp

A deployment.

[type OstreeDeployment]

Returns

TRUE if deployments have the same osname, csum, and deployserial


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);

Parameters

self

Deployment

 

Returns

Boot configuration.

[transfer none]


ostree_deployment_get_origin ()

GKeyFile *
ostree_deployment_get_origin (OstreeDeployment *self);

Parameters

self

Deployment

 

Returns

Origin.

[transfer none]


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().

Parameters

self

A deployment

 

Returns

Path to deployment root directory, relative to sysroot.

[transfer full]


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().

Parameters

self

Deployment

 

Returns

TRUE if deployment will not be subject to GC

Since: 2018.3


ostree_deployment_is_staged ()

gboolean
ostree_deployment_is_staged (OstreeDeployment *self);

Parameters

self

Deployment

 

Returns

TRUE if deployment should be "finalized" at shutdown time

Since: 2018.3


ostree_deployment_set_index ()

void
ostree_deployment_set_index (OstreeDeployment *self,
                             int index);

ostree_deployment_set_bootserial ()

void
ostree_deployment_set_bootserial (OstreeDeployment *self,
                                  int index);

ostree_deployment_set_bootconfig ()

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

ostree_deployment_set_origin ()

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

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.

Parameters

origin

An origin

 

Since: 2018.3


ostree_deployment_clone ()

OstreeDeployment *
ostree_deployment_clone (OstreeDeployment *self);

Parameters

self

Deployment

 

Returns

New deep copy of self .

[transfer full]


ostree_deployment_unlocked_state_to_string ()

const char *
ostree_deployment_unlocked_state_to_string
                               (OstreeDeploymentUnlockedState state);

Since: 2016.4

Types and Values

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;
} OstreeDeployment;

Members

int index;

Global offset

 

char *osname;

   

char *csum;

OSTree checksum of tree

 

int deployserial;

How many times this particular csum appears in deployment list

 

char *bootcsum;

Checksum of kernel+initramfs

 

int bootserial;

An integer assigned to this tree per its ${bootcsum}

 

OstreeBootconfigParser *bootconfig;

Bootloader configuration

 

GKeyFile *origin;

How to construct an upgraded version of this tree

 

OstreeDeploymentUnlockedState unlocked;

The unlocked state

 

gboolean staged;

TRUE iff this deployment is staged