SbuildChroot

SbuildChroot — chroot object

Synopsis




            SbuildChroot;
            SbuildChrootClass;
SbuildChroot* sbuild_chroot_new             (void);
SbuildChroot* sbuild_chroot_new_from_keyfile
                                            (GKeyFile *keyfile,
                                             const char *group);
const char* sbuild_chroot_get_name          (const SbuildChroot *restrict chroot);
void        sbuild_chroot_set_name          (SbuildChroot *chroot,
                                             const char *name);
const char* sbuild_chroot_get_description   (const SbuildChroot *restrict chroot);
void        sbuild_chroot_set_description   (SbuildChroot *chroot,
                                             const char *description);
const char* sbuild_chroot_get_location      (const SbuildChroot *restrict chroot);
void        sbuild_chroot_set_location      (SbuildChroot *chroot,
                                             const char *location);
char**      sbuild_chroot_get_groups        (const SbuildChroot *restrict chroot);
void        sbuild_chroot_set_groups        (SbuildChroot *chroot,
                                             char **groups);
char**      sbuild_chroot_get_root_groups   (const SbuildChroot *restrict chroot);
void        sbuild_chroot_set_root_groups   (SbuildChroot *chroot,
                                             char **groups);
char**      sbuild_chroot_get_aliases       (const SbuildChroot *restrict chroot);
void        sbuild_chroot_set_aliases       (SbuildChroot *chroot,
                                             char **aliases);
void        sbuild_chroot_print_details     (SbuildChroot *chroot,
                                             FILE *file);

Object Hierarchy


  GObject
   +----SbuildChroot

Properties


  "aliases"              GStrv                 : Read / Write / Construct
  "description"          gchararray            : Read / Write / Construct
  "groups"               GStrv                 : Read / Write / Construct
  "location"             gchararray            : Read / Write / Construct
  "name"                 gchararray            : Read / Write / Construct
  "root-groups"          GStrv                 : Read / Write / Construct

Description

This object contains all of the metadata associated with a single chroot. This is the in-core representation of a chroot definition in the configuration file, and may be initialised directly from an open GKeyFile.

This object is a container of information only. The only things it can do are satisfying requests for information and printing its details.

Details

SbuildChroot

typedef struct _SbuildChroot SbuildChroot;

SbuildChroot object.


SbuildChrootClass

typedef struct {
  GObjectClass parent;
} SbuildChrootClass;

SbuildChroot class.

GObjectClass parent; the parent class

sbuild_chroot_new ()

SbuildChroot* sbuild_chroot_new             (void);

Creates a new SbuildChroot.

Returns : the newly created SbuildChroot.

sbuild_chroot_new_from_keyfile ()

SbuildChroot* sbuild_chroot_new_from_keyfile
                                            (GKeyFile *keyfile,
                                             const char *group);

Creates a new SbuildChroot.

keyfile : the GKeyFile containing the chroot configuration
group : the group in keyfile to use
Returns : the newly created SbuildChroot.

sbuild_chroot_get_name ()

const char* sbuild_chroot_get_name          (const SbuildChroot *restrict chroot);

Get the name of the chroot.

chroot : an SbuildChroot
Returns : a string. This string points to internally allocated storage in the chroot and must not be freed, modified or stored.

sbuild_chroot_set_name ()

void        sbuild_chroot_set_name          (SbuildChroot *chroot,
                                             const char *name);

Set the name of a chroot.

chroot : an SbuildChroot.
name : the name to set.

sbuild_chroot_get_description ()

const char* sbuild_chroot_get_description   (const SbuildChroot *restrict chroot);

Get the description of the chroot.

chroot : an SbuildChroot
Returns : a string. This string points to internally allocated storage in the chroot and must not be freed, modified or stored.

sbuild_chroot_set_description ()

void        sbuild_chroot_set_description   (SbuildChroot *chroot,
                                             const char *description);

Set the description of a chroot.

chroot : an SbuildChroot.
description : the description to set.

sbuild_chroot_get_location ()

const char* sbuild_chroot_get_location      (const SbuildChroot *restrict chroot);

Get the location of the chroot.

chroot : an SbuildChroot
Returns : a string. This string points to internally allocated storage in the chroot and must not be freed, modified or stored.

sbuild_chroot_set_location ()

void        sbuild_chroot_set_location      (SbuildChroot *chroot,
                                             const char *location);

Set the location of a chroot.

chroot : an SbuildChroot.
location : the location to set.

sbuild_chroot_get_groups ()

char**      sbuild_chroot_get_groups        (const SbuildChroot *restrict chroot);

Get the groups of the chroot.

chroot : an SbuildChroot
Returns : a string. This string points to internally allocated storage in the chroot and must not be freed, modified or stored.

sbuild_chroot_set_groups ()

void        sbuild_chroot_set_groups        (SbuildChroot *chroot,
                                             char **groups);

Set the groups of a chroot.

chroot : an SbuildChroot.
groups : the groups to set.

sbuild_chroot_get_root_groups ()

char**      sbuild_chroot_get_root_groups   (const SbuildChroot *restrict chroot);

Get the root groups of the chroot.

chroot : an SbuildChroot
Returns : a string. This string points to internally allocated storage in the chroot and must not be freed, modified or stored.

sbuild_chroot_set_root_groups ()

void        sbuild_chroot_set_root_groups   (SbuildChroot *chroot,
                                             char **groups);

Set the groups of a chroot.

chroot : an SbuildChroot.
groups : the groups to set.

sbuild_chroot_get_aliases ()

char**      sbuild_chroot_get_aliases       (const SbuildChroot *restrict chroot);

Get the aliases of the chroot.

chroot : an SbuildChroot
Returns : a string. This string points to internally allocated storage in the chroot and must not be freed, modified or stored.

sbuild_chroot_set_aliases ()

void        sbuild_chroot_set_aliases       (SbuildChroot *chroot,
                                             char **aliases);

Set the aliases of a chroot.

chroot : an SbuildChroot.
aliases : the aliases to set.

sbuild_chroot_print_details ()

void        sbuild_chroot_print_details     (SbuildChroot *chroot,
                                             FILE *file);

Print detailed information about chroot to file. The information is printed in plain text with one line per property.

chroot : an SbuildChroot.
file : the file to output to.

Properties

The "aliases" property

  "aliases"              GStrv                 : Read / Write / Construct

Alternate names for this chroot.


The "description" property

  "description"          gchararray            : Read / Write / Construct

The description of the chroot.

Default value: ""


The "groups" property

  "groups"               GStrv                 : Read / Write / Construct

The groups allowed to use this chroot.


The "location" property

  "location"             gchararray            : Read / Write / Construct

The location (path) of the chroot.

Default value: ""


The "name" property

  "name"                 gchararray            : Read / Write / Construct

The name of the chroot.

Default value: ""


The "root-groups" property

  "root-groups"          GStrv                 : Read / Write / Construct

The groups allowed to use this chroot as root.