Skip to content

Commit f36b853

Browse files
author
Libmodulemd CI
committed
Updating libmodulemd docs for 5d2968698c44874262904e3fd3e8be77156d0b5f
Signed-off-by: Libmodulemd CI <[email protected]>
1 parent cff134f commit f36b853

File tree

6 files changed

+114
-1
lines changed

6 files changed

+114
-1
lines changed

‎libmodulemd/latest/ch18.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1416,6 +1416,10 @@
14161416
</dt>
14171417
<dd></dd>
14181418
<dt>
1419+
<a class="link" href="modulemd-2.0-Modulemd.Module.html#modulemd-module-clear-xmds" title="modulemd_module_clear_xmds ()">modulemd_module_clear_xmds</a>, function in <a class="link" href="modulemd-2.0-Modulemd.Module.html" title="Modulemd.Module">Modulemd.Module</a>
1420+
</dt>
1421+
<dd></dd>
1422+
<dt>
14191423
<a class="link" href="modulemd-2.0-Modulemd.Module.html#modulemd-module-copy" title="modulemd_module_copy ()">modulemd_module_copy</a>, function in <a class="link" href="modulemd-2.0-Modulemd.Module.html" title="Modulemd.Module">Modulemd.Module</a>
14201424
</dt>
14211425
<dd></dd>
@@ -1488,6 +1492,10 @@
14881492
</dt>
14891493
<dd></dd>
14901494
<dt>
1495+
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-clear-xmds" title="modulemd_module_index_clear_xmds ()">modulemd_module_index_clear_xmds</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html" title="Modulemd.ModuleIndex">Modulemd.ModuleIndex</a>
1496+
</dt>
1497+
<dd></dd>
1498+
<dt>
14911499
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-dump-to-custom" title="modulemd_module_index_dump_to_custom ()">modulemd_module_index_dump_to_custom</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html" title="Modulemd.ModuleIndex">Modulemd.ModuleIndex</a>
14921500
</dt>
14931501
<dd></dd>
@@ -2188,6 +2196,10 @@
21882196
</dt>
21892197
<dd></dd>
21902198
<dt>
2199+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-clear-xmd" title="modulemd_module_stream_v2_clear_xmd ()">modulemd_module_stream_v2_clear_xmd</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html" title="Modulemd.ModuleStreamV2">Modulemd.ModuleStreamV2</a>
2200+
</dt>
2201+
<dd></dd>
2202+
<dt>
21912203
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2-(Private).html#modulemd-module-stream-v2-emit-yaml" title="modulemd_module_stream_v2_emit_yaml ()">modulemd_module_stream_v2_emit_yaml</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2-(Private).html" title="Modulemd.ModuleStreamV2 (Private)">Modulemd.ModuleStreamV2 (Private)</a>
21922204
</dt>
21932205
<dd></dd>

‎libmodulemd/latest/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h3 class="author">
2323
          </p></div></div>
2424
</div></div></div>
2525
<div><p class="releaseinfo">
26-
for Modulemd 2.13.1
26+
for Modulemd 2.14.0
2727

2828
</p></div>
2929
<div><p class="copyright">Copyright © 2017-2018 Stephen Gallagher</p></div>

‎libmodulemd/latest/modulemd-2.0-Modulemd.Module.html‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,14 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.Module.top_of_pag
184184
<a class="link" href="modulemd-2.0-Modulemd.Module.html#modulemd-module-get-newest-active-obsoletes" title="modulemd_module_get_newest_active_obsoletes ()">modulemd_module_get_newest_active_obsoletes</a> <span class="c_punctuation">()</span>
185185
</td>
186186
</tr>
187+
<tr>
188+
<td class="function_type">
189+
<span class="returnvalue">void</span>
190+
</td>
191+
<td class="function_name">
192+
<a class="link" href="modulemd-2.0-Modulemd.Module.html#modulemd-module-clear-xmds" title="modulemd_module_clear_xmds ()">modulemd_module_clear_xmds</a> <span class="c_punctuation">()</span>
193+
</td>
194+
</tr>
187195
</tbody>
188196
</table></div>
189197
</div>
@@ -923,6 +931,32 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.Module.top_of_pag
923931
</div>
924932
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
925933
</div>
934+
<hr>
935+
<div class="refsect2">
936+
<a name="modulemd-module-clear-xmds"></a><h3>modulemd_module_clear_xmds ()</h3>
937+
<pre class="programlisting"><span class="returnvalue">void</span>
938+
modulemd_module_clear_xmds (<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="type">ModulemdModule</span></a> *self</code></em>);</pre>
939+
<p>Iterates through all <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> entries in this
940+
<a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="type">ModulemdModule</span></a> and removes any XMD sections that are present. This is
941+
generally done to trim down the metadata to only the portions that are
942+
useful to the package manager.</p>
943+
<div class="refsect3">
944+
<a name="modulemd-module-clear-xmds.parameters"></a><h4>Parameters</h4>
945+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
946+
<colgroup>
947+
<col width="150px" class="parameters_name">
948+
<col class="parameters_description">
949+
<col width="200px" class="parameters_annotations">
950+
</colgroup>
951+
<tbody><tr>
952+
<td class="parameter_name"><p>self</p></td>
953+
<td class="parameter_description"><p>This <a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="type">ModulemdModule</span></a> object. </p></td>
954+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
955+
</tr></tbody>
956+
</table></div>
957+
</div>
958+
<p class="since">Since: 2.14.0</p>
959+
</div>
926960
</div>
927961
<div class="refsect1">
928962
<a name="modulemd-2.0-Modulemd.Module.other_details"></a><h2>Types and Values</h2>

‎libmodulemd/latest/modulemd-2.0-Modulemd.ModuleIndex.html‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,14 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
259259
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-upgrade-defaults" title="modulemd_module_index_upgrade_defaults ()">modulemd_module_index_upgrade_defaults</a> <span class="c_punctuation">()</span>
260260
</td>
261261
</tr>
262+
<tr>
263+
<td class="function_type">
264+
<span class="returnvalue">void</span>
265+
</td>
266+
<td class="function_name">
267+
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-clear-xmds" title="modulemd_module_index_clear_xmds ()">modulemd_module_index_clear_xmds</a> <span class="c_punctuation">()</span>
268+
</td>
269+
</tr>
262270
</tbody>
263271
</table></div>
264272
</div>
@@ -1576,6 +1584,32 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
15761584
</div>
15771585
<p class="since">Since: <a class="link" href="ch05.html#api-index-2.0">2.0</a></p>
15781586
</div>
1587+
<hr>
1588+
<div class="refsect2">
1589+
<a name="modulemd-module-index-clear-xmds"></a><h3>modulemd_module_index_clear_xmds ()</h3>
1590+
<pre class="programlisting"><span class="returnvalue">void</span>
1591+
modulemd_module_index_clear_xmds (<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a> *self</code></em>);</pre>
1592+
<p>Iterates through all <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> entries in this
1593+
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a> and removes any XMD sections that are present. This is
1594+
generally done to trim down the metadata to only the portions that are
1595+
useful to the package manager.</p>
1596+
<div class="refsect3">
1597+
<a name="modulemd-module-index-clear-xmds.parameters"></a><h4>Parameters</h4>
1598+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
1599+
<colgroup>
1600+
<col width="150px" class="parameters_name">
1601+
<col class="parameters_description">
1602+
<col width="200px" class="parameters_annotations">
1603+
</colgroup>
1604+
<tbody><tr>
1605+
<td class="parameter_name"><p>self</p></td>
1606+
<td class="parameter_description"><p>This <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a> object.</p></td>
1607+
<td class="parameter_annotations"> </td>
1608+
</tr></tbody>
1609+
</table></div>
1610+
</div>
1611+
<p class="since">Since: 2.14.0</p>
1612+
</div>
15791613
</div>
15801614
<div class="refsect1">
15811615
<a name="modulemd-2.0-Modulemd.ModuleIndex.other_details"></a><h2>Types and Values</h2>

‎libmodulemd/latest/modulemd-2.0-Modulemd.ModuleStreamV2.html‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,14 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleStreamV2.to
579579
<span class="returnvalue">void</span>
580580
</td>
581581
<td class="function_name">
582+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-clear-xmd" title="modulemd_module_stream_v2_clear_xmd ()">modulemd_module_stream_v2_clear_xmd</a> <span class="c_punctuation">()</span>
583+
</td>
584+
</tr>
585+
<tr>
586+
<td class="function_type">
587+
<span class="returnvalue">void</span>
588+
</td>
589+
<td class="function_name">
582590
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-set-static-context" title="modulemd_module_stream_v2_set_static_context ()">modulemd_module_stream_v2_set_static_context</a> <span class="c_punctuation">()</span>
583591
</td>
584592
</tr>
@@ -2730,6 +2738,28 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleStreamV2.to
27302738
</div>
27312739
<hr>
27322740
<div class="refsect2">
2741+
<a name="modulemd-module-stream-v2-clear-xmd"></a><h3>modulemd_module_stream_v2_clear_xmd ()</h3>
2742+
<pre class="programlisting"><span class="returnvalue">void</span>
2743+
modulemd_module_stream_v2_clear_xmd (<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> *self</code></em>);</pre>
2744+
<p>Removes all XMD data from this <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a></p>
2745+
<div class="refsect3">
2746+
<a name="modulemd-module-stream-v2-clear-xmd.parameters"></a><h4>Parameters</h4>
2747+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
2748+
<colgroup>
2749+
<col width="150px" class="parameters_name">
2750+
<col class="parameters_description">
2751+
<col width="200px" class="parameters_annotations">
2752+
</colgroup>
2753+
<tbody><tr>
2754+
<td class="parameter_name"><p>self</p></td>
2755+
<td class="parameter_description"><p>This <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> object. </p></td>
2756+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
2757+
</tr></tbody>
2758+
</table></div>
2759+
</div>
2760+
</div>
2761+
<hr>
2762+
<div class="refsect2">
27332763
<a name="modulemd-module-stream-v2-set-static-context"></a><h3>modulemd_module_stream_v2_set_static_context ()</h3>
27342764
<pre class="programlisting"><span class="returnvalue">void</span>
27352765
modulemd_module_stream_v2_set_static_context

‎libmodulemd/latest/modulemd-2.0.devhelp2‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,7 @@
250250
<keyword type="function" name="modulemd_module_get_translation ()" link="modulemd-2.0-Modulemd.Module.html#modulemd-module-get-translation" since="2.8"/>
251251
<keyword type="function" name="modulemd_module_get_obsoletes ()" link="modulemd-2.0-Modulemd.Module.html#modulemd-module-get-obsoletes" since="2.10"/>
252252
<keyword type="function" name="modulemd_module_get_newest_active_obsoletes ()" link="modulemd-2.0-Modulemd.Module.html#modulemd-module-get-newest-active-obsoletes" since="2.10"/>
253+
<keyword type="function" name="modulemd_module_clear_xmds ()" link="modulemd-2.0-Modulemd.Module.html#modulemd-module-clear-xmds" since="2.14.0"/>
253254
<keyword type="macro" name="MODULEMD_TYPE_MODULE" link="modulemd-2.0-Modulemd.Module.html#MODULEMD-TYPE-MODULE:CAPS"/>
254255
<keyword type="struct" name="ModulemdModule" link="modulemd-2.0-Modulemd.Module.html#ModulemdModule-struct"/>
255256
<keyword type="property" name="The “module-name” property" link="modulemd-2.0-Modulemd.Module.html#ModulemdModule--module-name"/>
@@ -279,6 +280,7 @@
279280
<keyword type="function" name="modulemd_module_index_get_stream_mdversion ()" link="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-get-stream-mdversion" since="2.0"/>
280281
<keyword type="function" name="modulemd_module_index_upgrade_streams ()" link="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-upgrade-streams" since="2.0"/>
281282
<keyword type="function" name="modulemd_module_index_upgrade_defaults ()" link="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-upgrade-defaults" since="2.0"/>
283+
<keyword type="function" name="modulemd_module_index_clear_xmds ()" link="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-clear-xmds" since="2.14.0"/>
282284
<keyword type="macro" name="MODULEMD_TYPE_MODULE_INDEX" link="modulemd-2.0-Modulemd.ModuleIndex.html#MODULEMD-TYPE-MODULE-INDEX:CAPS"/>
283285
<keyword type="struct" name="ModulemdModuleIndex" link="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex-struct"/>
284286
<keyword type="function" name="modulemd_module_index_merger_new ()" link="modulemd-2.0-Modulemd.ModuleIndexMerger.html#modulemd-module-index-merger-new" since="2.0"/>
@@ -461,6 +463,7 @@
461463
<keyword type="function" name="modulemd_module_stream_v2_get_dependencies ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-get-dependencies"/>
462464
<keyword type="function" name="modulemd_module_stream_v2_set_xmd ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-set-xmd" since="2.0"/>
463465
<keyword type="function" name="modulemd_module_stream_v2_get_xmd ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-get-xmd"/>
466+
<keyword type="function" name="modulemd_module_stream_v2_clear_xmd ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-clear-xmd"/>
464467
<keyword type="function" name="modulemd_module_stream_v2_set_static_context ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-set-static-context" since="2.11"/>
465468
<keyword type="function" name="modulemd_module_stream_v2_unset_static_context ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-unset-static-context" since="2.11"/>
466469
<keyword type="function" name="modulemd_module_stream_v2_is_static_context ()" link="modulemd-2.0-Modulemd.ModuleStreamV2.html#modulemd-module-stream-v2-is-static-context" since="2.11"/>

0 commit comments

Comments
 (0)