Modulemd.UpgradeHelper: Modulemd Reference Manual

Modulemd.UpgradeHelper

Modulemd.UpgradeHelper — Helpers to provide cues to ModulemdModuleStream upgrades.

Stability Level

Private, unless otherwise indicated

Functions

ModulemdUpgradeHelper *	modulemd_upgrade_helper_new ()
void	modulemd_upgrade_helper_add_known_stream ()
GStrv	modulemd_upgrade_helper_get_known_modules_as_strv ()
GStrv	modulemd_upgrade_helper_get_known_streams_as_strv ()
GPtrArray *	modulemd_upgrade_helper_get_known_streams_as_array ()

Types and Values

#define	MODULEMD_TYPE_UPGRADE_HELPER
	ModulemdUpgradeHelper

Object Hierarchy

    GObject
    ╰── ModulemdUpgradeHelper

Description

Functions

modulemd_upgrade_helper_new ()

ModulemdUpgradeHelper *
modulemd_upgrade_helper_new (void);

Returns

A newly-allocated ModulemdUpgradeHelper object. This object must be freed with g_object_unref().

[transfer full]

Since: 2.10

modulemd_upgrade_helper_add_known_stream ()

void
modulemd_upgrade_helper_add_known_stream
                               (ModulemdUpgradeHelper *self,
                                const gchar *module_name,
                                const gchar *stream_name);

This function adds a module:stream entry to the ModulemdUpgradeHelper. It will be used if and when libmodulemd needs to upgrade a ModulemdModuleStreamV2 object to a ModulemdModuleStreamV3 object if it encounters a module dependency that is specified as either [ ] (all streams) or [ -streamname ] (all but some exclusions).

Parameters

self	This ModulemdUpgradeHelper object.	[in]
module_name	The name of the known module being added.	[in]
stream_name	The name of the known module stream being added.	[in]

Since: 2.10

modulemd_upgrade_helper_get_known_modules_as_strv ()

GStrv
modulemd_upgrade_helper_get_known_modules_as_strv
                               (ModulemdUpgradeHelper *self);

Parameters

self

This ModulemdUpgradeHelper.

[in]

Returns

A list of known modules to provide clues to the stream upgrade process.

[transfer full]

Since: 2.10

modulemd_upgrade_helper_get_known_streams_as_strv ()

GStrv
modulemd_upgrade_helper_get_known_streams_as_strv
                               (ModulemdUpgradeHelper *self,
                                const gchar *module_name);

Parameters

self	This ModulemdUpgradeHelper.	[in]
module_name	The name of the module to return a list of known streams for.	[in]

Returns

A list of known streams to provide clues to the stream upgrade process.

[transfer full]

Since: 2.10

modulemd_upgrade_helper_get_known_streams_as_array ()

GPtrArray *
modulemd_upgrade_helper_get_known_streams_as_array
                               (ModulemdUpgradeHelper *self,
                                const gchar *module_name);

Parameters

self	This ModulemdUpgradeHelper.	[in]
module_name	The name of the module to return a list of known streams for.	[in]

Returns

A list of known streams to provide clues to the stream upgrade process.

[transfer container]

Since: 2.10

Types and Values

MODULEMD_TYPE_UPGRADE_HELPER

#define MODULEMD_TYPE_UPGRADE_HELPER (modulemd_upgrade_helper_get_type ())

ModulemdUpgradeHelper

typedef struct _ModulemdUpgradeHelper ModulemdUpgradeHelper;