Skip to content

Commit b05cc8c

Browse files
sgallaghersgallagher
committed
Updating libmodulemd docs for 019fb215ce92b0201f320793de03349875d48d01
1 parent 3e62e85 commit b05cc8c

29 files changed

+1209
-3605
lines changed

‎libmodulemd/latest/ModulemdModuleStream.html‎

Lines changed: 3 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,6 @@ <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">
121113
<a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
122114
</td>
123115
<td class="function_name">
@@ -239,12 +231,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
239231
<tr>
240232
<td class="property_type">
241233
<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>
248234
<td class="property_name"><a class="link" href="ModulemdModuleStream.html#ModulemdModuleStream--arch" title="The “arch” property">arch</a></td>
249235
<td class="property_flags">Read / Write / Construct</td>
250236
</tr>
@@ -279,7 +265,7 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
279265
</tbody>
280266
</table></div>
281267
</div>
282-
<a name="ModulemdModule"></a><div class="refsect1">
268+
<div class="refsect1">
283269
<a name="ModulemdModuleStream.other"></a><h2>Types and Values</h2>
284270
<div class="informaltable"><table class="informaltable" width="100%" border="0">
285271
<colgroup>
@@ -288,10 +274,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
288274
</colgroup>
289275
<tbody>
290276
<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>
295277
<td class="datatype_keyword">enum</td>
296278
<td class="function_name"><a class="link" href="ModulemdModuleStream.html#ModulemdModuleStreamVersionEnum" title="enum ModulemdModuleStreamVersionEnum">ModulemdModuleStreamVersionEnum</a></td>
297279
</tr>
@@ -305,10 +287,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
305287
</tr>
306288
<tr>
307289
<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>
312290
<td class="function_name"><a class="link" href="ModulemdModuleStream.html#ModulemdModuleStream-struct" title="ModulemdModuleStream">ModulemdModuleStream</a></td>
313291
</tr>
314292
</tbody>
@@ -319,11 +297,9 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
319297
<pre class="screen"> <a href="https://developer.gnome.org/gobject/stable/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
320298
<span class="lineart">╰──</span> ModulemdModuleStreamVersionEnum
321299
<a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
322-
<span class="lineart">├──</span> ModulemdModule
323300
<span class="lineart">╰──</span> ModulemdModuleStream
324301
<span class="lineart">├──</span> <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV1.html#ModulemdModuleStreamV1">ModulemdModuleStreamV1</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>
302+
<span class="lineart">╰──</span> <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2">ModulemdModuleStreamV2</a>
327303
</pre>
328304
</div>
329305
<div class="refsect1">
@@ -657,10 +633,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
657633
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>,
658634
<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>,
659635
<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>
664636
<p>Return an upgraded copy of this object. Does not modify the original.</p>
665637
<div class="refsect3">
666638
<a name="modulemd-module-stream-upgrade.parameters"></a><h4>Parameters</h4>
@@ -701,54 +673,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
701673
</div>
702674
<hr>
703675
<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">
752676
<a name="modulemd-module-stream-validate"></a><h3>modulemd_module_stream_validate ()</h3>
753677
<pre class="programlisting"><a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
754678
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>,
@@ -1232,15 +1156,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
12321156
<div class="refsect1">
12331157
<a name="ModulemdModuleStream.other_details"></a><h2>Types and Values</h2>
12341158
<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">
12441159
<a name="ModulemdModuleStreamVersionEnum"></a><h3>enum ModulemdModuleStreamVersionEnum</h3>
12451160
<div class="refsect3">
12461161
<a name="ModulemdModuleStreamVersionEnum.members"></a><h4>Members</h4>
@@ -1283,14 +1198,6 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
12831198
<td class="enum_member_annotations"> </td>
12841199
</tr>
12851200
<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>
12941201
<td class="enum_member_name"><p><a name="MD-MODULESTREAM-VERSION-LATEST:CAPS"></a>MD_MODULESTREAM_VERSION_LATEST</p></td>
12951202
<td class="enum_member_description">
12961203
<p>Represents the highest-supported version of
@@ -1342,27 +1249,13 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
13421249
</div>
13431250
<hr>
13441251
<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">
13501252
<a name="ModulemdModuleStream-struct"></a><h3>ModulemdModuleStream</h3>
13511253
<pre class="programlisting">typedef struct _ModulemdModuleStream ModulemdModuleStream;</pre>
13521254
</div>
13531255
</div>
13541256
<div class="refsect1">
13551257
<a name="ModulemdModuleStream.property-details"></a><h2>Property Details</h2>
13561258
<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">
13661259
<a name="ModulemdModuleStream--arch"></a><h3>The <code class="literal">“arch”</code> property</h3>
13671260
<pre class="programlisting"> “arch” <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
13681261
<p>The processor architecture of this module stream.</p>
@@ -1386,7 +1279,7 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
13861279
<p>The metadata version of this ModuleStream object. Read-only.</p>
13871280
<p>Owner: ModulemdModuleStream</p>
13881281
<p>Flags: Read</p>
1389-
<p>Allowed values: &lt;= 3</p>
1282+
<p>Allowed values: &lt;= 2</p>
13901283
<p>Default value: 0</p>
13911284
</div>
13921285
<hr>

‎libmodulemd/latest/ch01.html‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,6 @@
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>
8581
<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>
8682
</dt>
8783
<dt>

‎libmodulemd/latest/ch02.html‎

Lines changed: 2 additions & 13 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.BuildConfig.html" title="Modulemd.BuildConfig">
10+
<link rel="next" href="modulemd-2.0-Modulemd.Buildopts-(Private).html" title="Modulemd.Buildopts (Private)">
1111
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
1212
<link rel="stylesheet" href="style.css" type="text/css">
1313
</head>
@@ -17,16 +17,13 @@
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.BuildConfig.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.Buildopts-(Private).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>
3027
<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
3128
by internal consumers.</span>
3229
</dt>
@@ -79,14 +76,6 @@
7976
used by internal consumers.</span>
8077
</dt>
8178
<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>
9079
<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
9180
by internal consumers.</span>
9281
</dt>

0 commit comments

Comments
 (0)