Skip to content

Commit 13b71a5

Browse files
sgallaghersgallagher
committed
Updating libmodulemd docs for bce5be090784f4527bb4ccb2591ee16d5e8cf78c
1 parent b05cc8c commit 13b71a5

29 files changed

+3605
-1209
lines changed

‎libmodulemd/latest/ModulemdModuleStream.html‎

Lines changed: 110 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,14 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
110110
</tr>
111111
<tr>
112112
<td class="function_type">
113+
<a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="returnvalue">ModulemdModule</span></a> *
114+
</td>
115+
<td class="function_name">
116+
<a class="link" href="ModulemdModuleStream.html#modulemd-module-stream-upgrade-ext" title="modulemd_module_stream_upgrade_ext ()">modulemd_module_stream_upgrade_ext</a> <span class="c_punctuation">()</span>
117+
</td>
118+
</tr>
119+
<tr>
120+
<td class="function_type">
113121
<a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
114122
</td>
115123
<td class="function_name">
@@ -231,6 +239,12 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
231239
<tr>
232240
<td class="property_type">
233241
<a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
242+
<td class="property_name"><a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule--module-name" title="The “module-name” property">module-name</a></td>
243+
<td class="property_flags">Read / Write / Construct Only</td>
244+
</tr>
245+
<tr>
246+
<td class="property_type">
247+
<a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
234248
<td class="property_name"><a class="link" href="ModulemdModuleStream.html#ModulemdModuleStream--arch" title="The “arch” property">arch</a></td>
235249
<td class="property_flags">Read / Write / Construct</td>
236250
</tr>
@@ -265,7 +279,7 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
265279
</tbody>
266280
</table></div>
267281
</div>
268-
<div class="refsect1">
282+
<a name="ModulemdModule"></a><div class="refsect1">
269283
<a name="ModulemdModuleStream.other"></a><h2>Types and Values</h2>
270284
<div class="informaltable"><table class="informaltable" width="100%" border="0">
271285
<colgroup>
@@ -274,6 +288,10 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
274288
</colgroup>
275289
<tbody>
276290
<tr>
291+
<td class="define_keyword">#define</td>
292+
<td class="function_name"><a class="link" href="ModulemdModuleStream.html#MMD-MAXCONTEXTLEN:CAPS" title="MMD_MAXCONTEXTLEN">MMD_MAXCONTEXTLEN</a></td>
293+
</tr>
294+
<tr>
277295
<td class="datatype_keyword">enum</td>
278296
<td class="function_name"><a class="link" href="ModulemdModuleStream.html#ModulemdModuleStreamVersionEnum" title="enum ModulemdModuleStreamVersionEnum">ModulemdModuleStreamVersionEnum</a></td>
279297
</tr>
@@ -287,6 +305,10 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
287305
</tr>
288306
<tr>
289307
<td class="datatype_keyword"> </td>
308+
<td class="function_name"><a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule-struct" title="ModulemdModule">ModulemdModule</a></td>
309+
</tr>
310+
<tr>
311+
<td class="datatype_keyword"> </td>
290312
<td class="function_name"><a class="link" href="ModulemdModuleStream.html#ModulemdModuleStream-struct" title="ModulemdModuleStream">ModulemdModuleStream</a></td>
291313
</tr>
292314
</tbody>
@@ -297,9 +319,11 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
297319
<pre class="screen"> <a href="https://developer.gnome.org/gobject/stable/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
298320
<span class="lineart">╰──</span> ModulemdModuleStreamVersionEnum
299321
<a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
322+
<span class="lineart">├──</span> ModulemdModule
300323
<span class="lineart">╰──</span> ModulemdModuleStream
301324
<span class="lineart">├──</span> <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV1.html#ModulemdModuleStreamV1">ModulemdModuleStreamV1</a>
302-
<span class="lineart">╰──</span> <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2">ModulemdModuleStreamV2</a>
325+
<span class="lineart">├──</span> <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2">ModulemdModuleStreamV2</a>
326+
<span class="lineart">╰──</span> <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3">ModulemdModuleStreamV3</a>
303327
</pre>
304328
</div>
305329
<div class="refsect1">
@@ -633,6 +657,10 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
633657
modulemd_module_stream_upgrade (<em class="parameter"><code><a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> *self</code></em>,
634658
<em class="parameter"><code><a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> mdversion</code></em>,
635659
<em class="parameter"><code><a href="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
660+
<div class="warning">
661+
<p><code class="literal">modulemd_module_stream_upgrade</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
662+
<p>Use <a class="link" href="ModulemdModuleStream.html#modulemd-module-stream-upgrade-ext" title="modulemd_module_stream_upgrade_ext ()"><code class="function">modulemd_module_stream_upgrade_ext()</code></a> instead.</p>
663+
</div>
636664
<p>Return an upgraded copy of this object. Does not modify the original.</p>
637665
<div class="refsect3">
638666
<a name="modulemd-module-stream-upgrade.parameters"></a><h4>Parameters</h4>
@@ -673,6 +701,54 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
673701
</div>
674702
<hr>
675703
<div class="refsect2">
704+
<a name="modulemd-module-stream-upgrade-ext"></a><h3>modulemd_module_stream_upgrade_ext ()</h3>
705+
<pre class="programlisting"><a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="returnvalue">ModulemdModule</span></a> *
706+
modulemd_module_stream_upgrade_ext (<em class="parameter"><code><a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> *self</code></em>,
707+
<em class="parameter"><code><a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> mdversion</code></em>,
708+
<em class="parameter"><code><a href="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
709+
<p>Does not modify the original <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> object, <em class="parameter"><code>from</code></em>
710+
.</p>
711+
<div class="refsect3">
712+
<a name="modulemd-module-stream-upgrade-ext.parameters"></a><h4>Parameters</h4>
713+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
714+
<colgroup>
715+
<col width="150px" class="parameters_name">
716+
<col class="parameters_description">
717+
<col width="200px" class="parameters_annotations">
718+
</colgroup>
719+
<tbody>
720+
<tr>
721+
<td class="parameter_name"><p>self</p></td>
722+
<td class="parameter_description"><p>This <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> object. </p></td>
723+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
724+
</tr>
725+
<tr>
726+
<td class="parameter_name"><p>mdversion</p></td>
727+
<td class="parameter_description"><p>The metadata version to upgrade to. If zero, upgrades to
728+
the highest-supported version. </p></td>
729+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
730+
</tr>
731+
<tr>
732+
<td class="parameter_name"><p>error</p></td>
733+
<td class="parameter_description"><p>A <a href="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> that will return the reason for an upgrade error. </p></td>
734+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
735+
</tr>
736+
</tbody>
737+
</table></div>
738+
</div>
739+
<div class="refsect3">
740+
<a name="modulemd-module-stream-upgrade-ext.returns"></a><h4>Returns</h4>
741+
<p>A newly-allocated <a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="type">ModulemdModule</span></a> containing a copy
742+
of this object upgraded to the requested version, possibly with multiple
743+
streams. Returns NULL and sets <em class="parameter"><code>error</code></em>
744+
appropriately if the upgrade could not
745+
be completed automatically. </p>
746+
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
747+
</div>
748+
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
749+
</div>
750+
<hr>
751+
<div class="refsect2">
676752
<a name="modulemd-module-stream-validate"></a><h3>modulemd_module_stream_validate ()</h3>
677753
<pre class="programlisting"><a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
678754
modulemd_module_stream_validate (<em class="parameter"><code><a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> *self</code></em>,
@@ -1156,6 +1232,15 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
11561232
<div class="refsect1">
11571233
<a name="ModulemdModuleStream.other_details"></a><h2>Types and Values</h2>
11581234
<div class="refsect2">
1235+
<a name="MMD-MAXCONTEXTLEN:CAPS"></a><h3>MMD_MAXCONTEXTLEN</h3>
1236+
<pre class="programlisting">#define MMD_MAXCONTEXTLEN 10
1237+
</pre>
1238+
<p>The ModuleStream v3 specification defines the maximum lenth of the context
1239+
field.</p>
1240+
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
1241+
</div>
1242+
<hr>
1243+
<div class="refsect2">
11591244
<a name="ModulemdModuleStreamVersionEnum"></a><h3>enum ModulemdModuleStreamVersionEnum</h3>
11601245
<div class="refsect3">
11611246
<a name="ModulemdModuleStreamVersionEnum.members"></a><h4>Members</h4>
@@ -1198,6 +1283,14 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
11981283
<td class="enum_member_annotations"> </td>
11991284
</tr>
12001285
<tr>
1286+
<td class="enum_member_name"><p><a name="MD-MODULESTREAM-VERSION-THREE:CAPS"></a>MD_MODULESTREAM_VERSION_THREE</p></td>
1287+
<td class="enum_member_description">
1288+
<p>Represents v3 of the <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a>
1289+
metadata format. Since: 2.10</p>
1290+
</td>
1291+
<td class="enum_member_annotations"> </td>
1292+
</tr>
1293+
<tr>
12011294
<td class="enum_member_name"><p><a name="MD-MODULESTREAM-VERSION-LATEST:CAPS"></a>MD_MODULESTREAM_VERSION_LATEST</p></td>
12021295
<td class="enum_member_description">
12031296
<p>Represents the highest-supported version of
@@ -1249,13 +1342,27 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
12491342
</div>
12501343
<hr>
12511344
<div class="refsect2">
1345+
<a name="ModulemdModule-struct"></a><h3>ModulemdModule</h3>
1346+
<pre class="programlisting">typedef struct _ModulemdModule ModulemdModule;</pre>
1347+
</div>
1348+
<hr>
1349+
<div class="refsect2">
12521350
<a name="ModulemdModuleStream-struct"></a><h3>ModulemdModuleStream</h3>
12531351
<pre class="programlisting">typedef struct _ModulemdModuleStream ModulemdModuleStream;</pre>
12541352
</div>
12551353
</div>
12561354
<div class="refsect1">
12571355
<a name="ModulemdModuleStream.property-details"></a><h2>Property Details</h2>
12581356
<div class="refsect2">
1357+
<a name="ModulemdModule--module-name"></a><h3>The <code class="literal">“module-name”</code> property</h3>
1358+
<pre class="programlisting"> “module-name” <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
1359+
<p>The name of this module.</p>
1360+
<p>Owner: ModulemdModule</p>
1361+
<p>Flags: Read / Write / Construct Only</p>
1362+
<p>Default value: NULL</p>
1363+
</div>
1364+
<hr>
1365+
<div class="refsect2">
12591366
<a name="ModulemdModuleStream--arch"></a><h3>The <code class="literal">“arch”</code> property</h3>
12601367
<pre class="programlisting"> “arch” <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
12611368
<p>The processor architecture of this module stream.</p>
@@ -1279,7 +1386,7 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
12791386
<p>The metadata version of this ModuleStream object. Read-only.</p>
12801387
<p>Owner: ModulemdModuleStream</p>
12811388
<p>Flags: Read</p>
1282-
<p>Allowed values: &lt;= 2</p>
1389+
<p>Allowed values: &lt;= 3</p>
12831390
<p>Default value: 0</p>
12841391
</div>
12851392
<hr>

‎libmodulemd/latest/ch01.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@
7878
by a modulemd YAML document of version 2.</span>
7979
</dt>
8080
<dt>
81+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStreamV3.html">Modulemd.ModuleStreamV3</a></span><span class="refpurpose"> — The data to represent a stream of a module as described
82+
by a modulemd YAML document of version 3.</span>
83+
</dt>
84+
<dt>
8185
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Profile.html">Modulemd.Profile</a></span><span class="refpurpose"> — Stores profile information for a module stream.</span>
8286
</dt>
8387
<dt>

‎libmodulemd/latest/ch02.html‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<link rel="home" href="index.html" title="Modulemd Reference Manual">
88
<link rel="up" href="modulemd-2.0.html" title="libmodulemd">
99
<link rel="prev" href="modulemd-2.0-Modulemd.Obsoletes.html" title="Modulemd.Obsoletes">
10-
<link rel="next" href="modulemd-2.0-Modulemd.Buildopts-(Private).html" title="Modulemd.Buildopts (Private)">
10+
<link rel="next" href="modulemd-2.0-Modulemd.BuildConfig.html" title="Modulemd.BuildConfig">
1111
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
1212
<link rel="stylesheet" href="style.css" type="text/css">
1313
</head>
@@ -17,13 +17,16 @@
1717
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
1818
<td><a accesskey="u" href="modulemd-2.0.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
1919
<td><a accesskey="p" href="modulemd-2.0-Modulemd.Obsoletes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
20-
<td><a accesskey="n" href="modulemd-2.0-Modulemd.Buildopts-(Private).html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
20+
<td><a accesskey="n" href="modulemd-2.0-Modulemd.BuildConfig.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
2121
</tr></table>
2222
<div class="chapter">
2323
<div class="titlepage"><div><div><h2 class="title">
2424
<a name="id-1.2.4"></a>Modulemd 2.0 Private Object Methods</h2></div></div></div>
2525
<div class="toc"><dl class="toc">
2626
<dt>
27+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.BuildConfig.html">Modulemd.BuildConfig</a></span><span class="refpurpose"> — Internal representation of a module build configuration</span>
28+
</dt>
29+
<dt>
2730
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Buildopts-(Private).html">Modulemd.Buildopts (Private)</a></span><span class="refpurpose"> — <span class="type">ModulemdBuildopts</span> methods that should be used only
2831
by internal consumers.</span>
2932
</dt>
@@ -76,6 +79,14 @@
7679
used by internal consumers.</span>
7780
</dt>
7881
<dt>
82+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.ModuleStreamV3-(Private).html">Modulemd.ModuleStreamV3 (Private)</a></span><span class="refpurpose"> — <span class="type">ModulemdModuleStreamV3</span> methods that should only be
83+
used by internal consumers.</span>
84+
</dt>
85+
<dt>
86+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.PackagerV3.html">Modulemd.PackagerV3</a></span><span class="refpurpose"> — Internal representation of the modulemd-packager v3
87+
format.</span>
88+
</dt>
89+
<dt>
7990
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Profile-(Private).html">Modulemd.Profile (Private)</a></span><span class="refpurpose"> — <span class="type">ModulemdProfile</span> methods that should be used only
8091
by internal consumers.</span>
8192
</dt>

0 commit comments

Comments
 (0)