You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ddclass="glossdef"><p>Parameter for returning results. Default is <acronymtitle="Free data after the code is done."><spanclass="acronym">transfer full</span></acronym>.</p></dd>
<p>This function takes a defaults object, upgrades it to <emclass="parameter"><code>index_mdversion</code></em>
149
-
if it
150
-
is lower and adds it to the <aclass="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><spanclass="type">ModulemdModule</span></a>. If it cannot upgrade it safely
151
-
or the defaults are not for this module, it will return an appropriate
152
-
error.</p>
148
+
<p>This function takes a <aclass="link" href="ModulemdDefaults.html" title="Modulemd.Defaults"><spanclass="type">ModulemdDefaults</span></a> object, upgrades it to
if its version is lower and adds it to the <aclass="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><spanclass="type">ModulemdModule</span></a>
151
+
object. If <emclass="parameter"><code>defaults</code></em>
152
+
cannot be upgraded safely or the <emclass="parameter"><code>defaults</code></em>
153
+
are not for <emclass="parameter"><code>self</code></em>
154
+
155
+
module, it will return an appropriate error.</p>
156
+
<p>(A use case is upgrading defaults of modules in a <aclass="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><spanclass="type">ModulemdModuleIndex</span></a> to
157
+
the highest defaults version added so far in the <aclass="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><spanclass="type">ModulemdModuleIndex</span></a>.)</p>
<tdclass="parameter_description"><p>A <aclass="link" href="ModulemdDefaults.html" title="Modulemd.Defaults"><spanclass="type">ModulemdDefaults</span></a> object to associate with this
170
-
<aclass="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><spanclass="type">ModulemdModule</span></a>. If the module_name in the <aclass="link" href="ModulemdDefaults.html" title="Modulemd.Defaults"><spanclass="type">ModulemdDefaults</span></a> object does not
171
-
match this module, it will be rejected. </p></td>
172
-
<tdclass="parameter_annotations"><spanclass="annotation">[<acronymtitle="Parameter for input. Default is transfer none."><spanclass="acronym">in</span></acronym>]</span></td>
174
+
<tdclass="parameter_description"><p>A <aclass="link" href="ModulemdDefaults.html" title="Modulemd.Defaults"><spanclass="type">ModulemdDefaults</span></a> object whose copy to
175
+
associate with this <aclass="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><spanclass="type">ModulemdModule</span></a>. A module name in <emclass="parameter"><code>defaults</code></em>
176
+
should
177
+
match a name in the <emclass="parameter"><code>self</code></em>
178
+
module. Pass <ahref="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><codeclass="literal">NULL</code></a> to unset the defaults. </p></td>
179
+
<tdclass="parameter_annotations"><spanclass="annotation">[<acronymtitle="Parameter for input. Default is transfer none."><spanclass="acronym">in</span></acronym>][<acronymtitle="NULL may be passed as the value in, out, in-out; or as a return value."><spanclass="acronym">nullable</span></acronym>]</span></td>
<tdclass="parameter_description"><p>The <aclass="link" href="ModulemdDefaults.html#ModulemdDefaultsVersionEnum" title="enum ModulemdDefaultsVersionEnum"><spanclass="type">ModulemdDefaultsVersionEnum</span></a> of the highest
177
-
defaults version added so far in the <aclass="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><spanclass="type">ModulemdModuleIndex</span></a>. If non-zero,
178
-
perform an upgrade to this version while adding <emclass="parameter"><code>defaults</code></em>
179
-
to <emclass="parameter"><code>self</code></em>
180
-
. If
181
-
the <emclass="parameter"><code>defaults</code></em>
182
-
already has a higher version, just copy it. </p></td>
183
+
<tdclass="parameter_description"><p>A minimal <aclass="link" href="ModulemdDefaults.html#ModulemdDefaultsVersionEnum" title="enum ModulemdDefaultsVersionEnum"><spanclass="type">ModulemdDefaultsVersionEnum</span></a> version to
<tdclass="parameter_annotations"><spanclass="annotation">[<acronymtitle="Parameter for input. Default is transfer none."><spanclass="acronym">in</span></acronym>]</span></td>
<p> The mdversion of the defaults that were added. Returns
199
+
<p> The upgraded version of the defaults that were added. Or
200
+
<aclass="link" href="ModulemdDefaults.html#MD-DEFAULTS-VERSION-UNSET:CAPS"><codeclass="literal">MD_DEFAULTS_VERSION_UNSET</code></a> if <emclass="parameter"><code>defaults</code></em>
201
+
was <ahref="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><codeclass="literal">NULL</code></a>. Returns
197
202
<aclass="link" href="ModulemdDefaults.html#MD-DEFAULTS-VERSION-ERROR:CAPS"><codeclass="literal">MD_DEFAULTS_VERSION_ERROR</code></a> and sets <emclass="parameter"><code>error</code></em>
198
-
if the default name didn't match
199
-
or the Defaults object couldn't be upgraded successfully to
203
+
if the defaults name didn't
204
+
match or the defaults object couldn't be upgraded successfully to
200
205
the <emclass="parameter"><code>index_mdversion</code></em>
201
-
. Returns <aclass="link" href="ModulemdDefaults.html#MD-DEFAULTS-VERSION-UNSET:CAPS"><codeclass="literal">MD_DEFAULTS_VERSION_UNSET</code></a> if <emclass="parameter"><code>defaults</code></em>
<p>Upgrades all <aclass="link" href="ModulemdDefaults.html" title="Modulemd.Defaults"><spanclass="type">ModulemdDefaults</span></a> objects in this index to <emclass="parameter"><code>mdversion</code></em>
1543
1543
if they
1544
-
are not already at that version.</p>
1544
+
are not already at that version. An attempt to downgrade or an attempt to
1545
+
upgrade beyond the latest supported version will report an error. In the
1546
+
case of a failure to upgrade a particular <aclass="link" href="ModulemdDefaults.html" title="Modulemd.Defaults"><spanclass="type">ModulemdDefaults</span></a> object of the
1547
+
index, an error will be reported and the index will be left in an undefined
<tdclass="parameter_description"><p>A <ahref="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError"><spanclass="type">GError</span></a> that contains information on why the index could
1567
-
not be upgraded in the event of an error. </p></td>
1568
-
<tdclass="parameter_annotations"><spanclass="annotation">[<acronymtitle="Parameter for returning results. Default is transfer full."><spanclass="acronym">out</span></acronym>]</span></td>
1570
+
<tdclass="parameter_description"><p>A <ahref="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError"><spanclass="type">GError</span></a> that contains information on why the
1571
+
index could not be upgraded in the event of an error. </p></td>
1572
+
<tdclass="parameter_annotations"><spanclass="annotation">[<acronymtitle="Parameter for returning results. Default is transfer full."><spanclass="acronym">out</span></acronym>][<acronymtitle="NULL may be passed instead of a pointer to a location."><spanclass="acronym">optional</span></acronym>]</span></td>
0 commit comments