Skip to content

Commit 307765a

Browse files
sgallaghersgallagher
committed
Updating libmodulemd docs for 30e254183c868f13d83e4d58edc71020c87b3a53
1 parent c32f70b commit 307765a

12 files changed

+525
-19
lines changed

‎libmodulemd/latest/ch02.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@
111111
by internal consumers.</span>
112112
</dt>
113113
<dt>
114+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.UpgradeHelper.html">Modulemd.UpgradeHelper</a></span><span class="refpurpose"> — Helpers to provide cues to <span class="type">ModulemdModuleStream</span>
115+
upgrades.</span>
116+
</dt>
117+
<dt>
114118
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Obsoletes-(Private).html">Modulemd.Obsoletes (Private)</a></span><span class="refpurpose"> — <span class="type">ModulemdObsoletes</span> methods that should only be used by
115119
internal consumers.</span>
116120
</dt>

‎libmodulemd/latest/ch15.html‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,10 @@
159159
</dt>
160160
<dd></dd>
161161
<dt>
162+
<a class="link" href="modulemd-2.0-Modulemd.Module-(Private).html#modulemd-module-associate-upgrade-helper" title="modulemd_module_associate_upgrade_helper ()">modulemd_module_associate_upgrade_helper</a>, function in <a class="link" href="modulemd-2.0-Modulemd.Module-(Private).html" title="Modulemd.Module (Private)">Modulemd.Module (Private)</a>
163+
</dt>
164+
<dd></dd>
165+
<dt>
162166
<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>, function in <a class="link" href="modulemd-2.0-Modulemd.Module.html" title="Modulemd.Module">Modulemd.Module</a>
163167
</dt>
164168
<dd></dd>
@@ -167,10 +171,18 @@
167171
</dt>
168172
<dd></dd>
169173
<dt>
174+
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-add-known-stream" title="modulemd_module_index_add_known_stream ()">modulemd_module_index_add_known_stream</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html" title="Modulemd.ModuleIndex">Modulemd.ModuleIndex</a>
175+
</dt>
176+
<dd></dd>
177+
<dt>
170178
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-add-obsoletes" title="modulemd_module_index_add_obsoletes ()">modulemd_module_index_add_obsoletes</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html" title="Modulemd.ModuleIndex">Modulemd.ModuleIndex</a>
171179
</dt>
172180
<dd></dd>
173181
<dt>
182+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStream-(Private).html#modulemd-module-stream-associate-upgrade-helper" title="modulemd_module_stream_associate_upgrade_helper ()">modulemd_module_stream_associate_upgrade_helper</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStream-(Private).html" title="Modulemd.ModuleStream (Private)">Modulemd.ModuleStream (Private)</a>
183+
</dt>
184+
<dd></dd>
185+
<dt>
174186
<a class="link" href="modulemd-2.0-Modulemd.ModuleStream-(Private).html#modulemd-module-stream-clear-autogen-module-name" title="modulemd_module_stream_clear_autogen_module_name ()">modulemd_module_stream_clear_autogen_module_name</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStream-(Private).html" title="Modulemd.ModuleStream (Private)">Modulemd.ModuleStream (Private)</a>
175187
</dt>
176188
<dd></dd>
@@ -847,19 +859,23 @@
847859
</dt>
848860
<dd></dd>
849861
<dt>
850-
modulemd_upgrade_helper_add_known_stream, function in Modulemd.UpgradeHelper
862+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-add-known-stream" title="modulemd_upgrade_helper_add_known_stream ()">modulemd_upgrade_helper_add_known_stream</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
863+
</dt>
864+
<dd></dd>
865+
<dt>
866+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-get-known-modules-as-strv" title="modulemd_upgrade_helper_get_known_modules_as_strv ()">modulemd_upgrade_helper_get_known_modules_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
851867
</dt>
852868
<dd></dd>
853869
<dt>
854-
modulemd_upgrade_helper_get_known_modules_as_strv, function in Modulemd.UpgradeHelper
870+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-get-known-streams-as-array" title="modulemd_upgrade_helper_get_known_streams_as_array ()">modulemd_upgrade_helper_get_known_streams_as_array</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
855871
</dt>
856872
<dd></dd>
857873
<dt>
858-
modulemd_upgrade_helper_get_known_streams_as_strv, function in Modulemd.UpgradeHelper
874+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-get-known-streams-as-strv" title="modulemd_upgrade_helper_get_known_streams_as_strv ()">modulemd_upgrade_helper_get_known_streams_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
859875
</dt>
860876
<dd></dd>
861877
<dt>
862-
modulemd_upgrade_helper_new, function in Modulemd.UpgradeHelper
878+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-new" title="modulemd_upgrade_helper_new ()">modulemd_upgrade_helper_new</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
863879
</dt>
864880
<dd></dd>
865881
<dt>

‎libmodulemd/latest/ch17.html‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@
753753
</dt>
754754
<dd></dd>
755755
<dt>
756-
ModulemdUpgradeHelper, struct in Modulemd.UpgradeHelper
756+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#ModulemdUpgradeHelper-struct" title="ModulemdUpgradeHelper">ModulemdUpgradeHelper</a>, struct in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
757757
</dt>
758758
<dd></dd>
759759
<dt>
@@ -1433,6 +1433,10 @@
14331433
</dt>
14341434
<dd></dd>
14351435
<dt>
1436+
<a class="link" href="modulemd-2.0-Modulemd.Module-(Private).html#modulemd-module-associate-upgrade-helper" title="modulemd_module_associate_upgrade_helper ()">modulemd_module_associate_upgrade_helper</a>, function in <a class="link" href="modulemd-2.0-Modulemd.Module-(Private).html" title="Modulemd.Module (Private)">Modulemd.Module (Private)</a>
1437+
</dt>
1438+
<dd></dd>
1439+
<dt>
14361440
<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>
14371441
</dt>
14381442
<dd></dd>
@@ -1493,6 +1497,10 @@
14931497
</dt>
14941498
<dd></dd>
14951499
<dt>
1500+
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-add-known-stream" title="modulemd_module_index_add_known_stream ()">modulemd_module_index_add_known_stream</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html" title="Modulemd.ModuleIndex">Modulemd.ModuleIndex</a>
1501+
</dt>
1502+
<dd></dd>
1503+
<dt>
14961504
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#modulemd-module-index-add-module-stream" title="modulemd_module_index_add_module_stream ()">modulemd_module_index_add_module_stream</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html" title="Modulemd.ModuleIndex">Modulemd.ModuleIndex</a>
14971505
</dt>
14981506
<dd></dd>
@@ -1653,6 +1661,10 @@
16531661
</dt>
16541662
<dd></dd>
16551663
<dt>
1664+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStream-(Private).html#modulemd-module-stream-associate-upgrade-helper" title="modulemd_module_stream_associate_upgrade_helper ()">modulemd_module_stream_associate_upgrade_helper</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStream-(Private).html" title="Modulemd.ModuleStream (Private)">Modulemd.ModuleStream (Private)</a>
1665+
</dt>
1666+
<dd></dd>
1667+
<dt>
16561668
<a class="link" href="ModulemdModuleStream.html#modulemd-module-stream-build-depends-on-stream" title="modulemd_module_stream_build_depends_on_stream ()">modulemd_module_stream_build_depends_on_stream</a>, function in <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream">ModulemdModuleStream</a>
16571669
</dt>
16581670
<dd></dd>
@@ -3649,31 +3661,27 @@
36493661
</dt>
36503662
<dd></dd>
36513663
<dt>
3652-
MODULEMD_TYPE_UPGRADE_HELPER, macro in Modulemd.UpgradeHelper
3653-
</dt>
3654-
<dd></dd>
3655-
<dt>
3656-
modulemd_upgrade_helper_add_known_stream, function in Modulemd.UpgradeHelper
3664+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#MODULEMD-TYPE-UPGRADE-HELPER:CAPS" title="MODULEMD_TYPE_UPGRADE_HELPER">MODULEMD_TYPE_UPGRADE_HELPER</a>, macro in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
36573665
</dt>
36583666
<dd></dd>
36593667
<dt>
3660-
modulemd_upgrade_helper_get_known_modules, function in gi-binding-renames
3668+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-add-known-stream" title="modulemd_upgrade_helper_add_known_stream ()">modulemd_upgrade_helper_add_known_stream</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
36613669
</dt>
36623670
<dd></dd>
36633671
<dt>
3664-
modulemd_upgrade_helper_get_known_modules_as_strv, function in Modulemd.UpgradeHelper
3672+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-get-known-modules-as-strv" title="modulemd_upgrade_helper_get_known_modules_as_strv ()">modulemd_upgrade_helper_get_known_modules_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
36653673
</dt>
36663674
<dd></dd>
36673675
<dt>
3668-
modulemd_upgrade_helper_get_known_streams, function in gi-binding-renames
3676+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-get-known-streams-as-array" title="modulemd_upgrade_helper_get_known_streams_as_array ()">modulemd_upgrade_helper_get_known_streams_as_array</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
36693677
</dt>
36703678
<dd></dd>
36713679
<dt>
3672-
modulemd_upgrade_helper_get_known_streams_as_strv, function in Modulemd.UpgradeHelper
3680+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-get-known-streams-as-strv" title="modulemd_upgrade_helper_get_known_streams_as_strv ()">modulemd_upgrade_helper_get_known_streams_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
36733681
</dt>
36743682
<dd></dd>
36753683
<dt>
3676-
modulemd_upgrade_helper_new, function in Modulemd.UpgradeHelper
3684+
<a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#modulemd-upgrade-helper-new" title="modulemd_upgrade_helper_new ()">modulemd_upgrade_helper_new</a>, function in <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html" title="Modulemd.UpgradeHelper">Modulemd.UpgradeHelper</a>
36773685
</dt>
36783686
<dd></dd>
36793687
<dt>

‎libmodulemd/latest/index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,10 @@ <h3 class="author">
206206
by internal consumers.</span>
207207
</dt>
208208
<dt>
209+
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.UpgradeHelper.html">Modulemd.UpgradeHelper</a></span><span class="refpurpose"> — Helpers to provide cues to <span class="type">ModulemdModuleStream</span>
210+
upgrades.</span>
211+
</dt>
212+
<dt>
209213
<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Obsoletes-(Private).html">Modulemd.Obsoletes (Private)</a></span><span class="refpurpose"> — <span class="type">ModulemdObsoletes</span> methods that should only be used by
210214
internal consumers.</span>
211215
</dt>

‎libmodulemd/latest/modulemd-2.0-Modulemd.Module-(Private).html‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,14 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.Module-(Private).
103103
<a class="link" href="modulemd-2.0-Modulemd.Module-(Private).html#modulemd-module-upgrade-streams" title="modulemd_module_upgrade_streams ()">modulemd_module_upgrade_streams</a> <span class="c_punctuation">()</span>
104104
</td>
105105
</tr>
106+
<tr>
107+
<td class="function_type">
108+
<span class="returnvalue">void</span>
109+
</td>
110+
<td class="function_name">
111+
<a class="link" href="modulemd-2.0-Modulemd.Module-(Private).html#modulemd-module-associate-upgrade-helper" title="modulemd_module_associate_upgrade_helper ()">modulemd_module_associate_upgrade_helper</a> <span class="c_punctuation">()</span>
112+
</td>
113+
</tr>
106114
</tbody>
107115
</table></div>
108116
</div>
@@ -421,6 +429,44 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.Module-(Private).
421429
</div>
422430
<p class="since">Since: <a class="link" href="ch05.html#api-index-2.0">2.0</a></p>
423431
</div>
432+
<hr>
433+
<div class="refsect2">
434+
<a name="modulemd-module-associate-upgrade-helper"></a><h3>modulemd_module_associate_upgrade_helper ()</h3>
435+
<pre class="programlisting"><span class="returnvalue">void</span>
436+
modulemd_module_associate_upgrade_helper
437+
(<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="type">ModulemdModule</span></a> *self</code></em>,
438+
<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#ModulemdUpgradeHelper"><span class="type">ModulemdUpgradeHelper</span></a> *upgrade_helper</code></em>);</pre>
439+
<p>Associates a <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#ModulemdUpgradeHelper"><span class="type">ModulemdUpgradeHelper</span></a>, usually from a <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a>,
440+
with this module to help with upgrades between <span class="type">ModuleStreamV2</span> and
441+
<span class="type">ModuleStreamV3</span>. This function will take a reference on the one passed in,
442+
so modifications to the <em class="parameter"><code>upgrade_helper</code></em>
443+
will affect subsequent changes to
444+
this <a class="link" href="modulemd-2.0-Modulemd.Module.html#ModulemdModule"><span class="type">ModulemdModule</span></a>.</p>
445+
<div class="refsect3">
446+
<a name="modulemd-module-associate-upgrade-helper.parameters"></a><h4>Parameters</h4>
447+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
448+
<colgroup>
449+
<col width="150px" class="parameters_name">
450+
<col class="parameters_description">
451+
<col width="200px" class="parameters_annotations">
452+
</colgroup>
453+
<tbody>
454+
<tr>
455+
<td class="parameter_name"><p>self</p></td>
456+
<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>
457+
<td class="parameter_annotations"> </td>
458+
</tr>
459+
<tr>
460+
<td class="parameter_name"><p>upgrade_helper</p></td>
461+
<td class="parameter_description"><p>a <a class="link" href="modulemd-2.0-Modulemd.UpgradeHelper.html#ModulemdUpgradeHelper"><span class="type">ModulemdUpgradeHelper</span></a> to associate
462+
with this module. </p></td>
463+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
464+
</tr>
465+
</tbody>
466+
</table></div>
467+
</div>
468+
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
469+
</div>
424470
</div>
425471
</div>
426472
<div class="footer">

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

Lines changed: 66 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-add-known-stream" title="modulemd_module_index_add_known_stream ()">modulemd_module_index_add_known_stream</a> <span class="c_punctuation">()</span>
268+
</td>
269+
</tr>
262270
</tbody>
263271
</table></div>
264272
</div>
@@ -1546,6 +1554,64 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
15461554
</div>
15471555
<p class="since">Since: <a class="link" href="ch05.html#api-index-2.0">2.0</a></p>
15481556
</div>
1557+
<hr>
1558+
<div class="refsect2">
1559+
<a name="modulemd-module-index-add-known-stream"></a><h3>modulemd_module_index_add_known_stream ()</h3>
1560+
<pre class="programlisting"><span class="returnvalue">void</span>
1561+
modulemd_module_index_add_known_stream
1562+
(<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a> *self</code></em>,
1563+
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *module_name</code></em>,
1564+
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stream_name</code></em>);</pre>
1565+
<p>This function adds a <code class="literal">module:stream</code> entry to the <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a>.
1566+
It will be used if and when libmodulemd needs to upgrade a
1567+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> object to a <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3"><span class="type">ModulemdModuleStreamV3</span></a> object if it
1568+
encounters a module dependency that is specified as either <code class="literal">[ ]</code>
1569+
(all streams) or <code class="literal">[ -streamname ]</code> (all but some exclusions).</p>
1570+
<p>When using the python bindings, a simplified way to set these values is to
1571+
call:</p>
1572+
<div class="informalexample">
1573+
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
1574+
<tbody>
1575+
<tr>
1576+
<td class="listing_lines" align="right"><pre>1
1577+
2</pre></td>
1578+
<td class="listing_code"><pre class="programlisting"><span class="n">idx</span> <span class="o">=</span> <span class="n">Modulemd</span><span class="p">.</span><span class="n">ModuleIndex</span><span class="p">.</span><span class="n">new</span><span class="p">()</span>
1579+
<span class="n">idx</span><span class="p">.</span><span class="n">set_known_streams</span><span class="p">({</span><span class="s">&quot;module_name&quot;</span><span class="o">:</span> <span class="p">[</span><span class="s">&quot;stream1&quot;</span><span class="p">,</span> <span class="s">&quot;stream2&quot;</span><span class="p">]})</span></pre></td>
1580+
</tr>
1581+
</tbody>
1582+
</table>
1583+
</div>
1584+
1585+
<p></p>
1586+
<div class="refsect3">
1587+
<a name="modulemd-module-index-add-known-stream.parameters"></a><h4>Parameters</h4>
1588+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
1589+
<colgroup>
1590+
<col width="150px" class="parameters_name">
1591+
<col class="parameters_description">
1592+
<col width="200px" class="parameters_annotations">
1593+
</colgroup>
1594+
<tbody>
1595+
<tr>
1596+
<td class="parameter_name"><p>self</p></td>
1597+
<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>
1598+
<td class="parameter_annotations"> </td>
1599+
</tr>
1600+
<tr>
1601+
<td class="parameter_name"><p>module_name</p></td>
1602+
<td class="parameter_description"><p>The name of the known module being added. </p></td>
1603+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
1604+
</tr>
1605+
<tr>
1606+
<td class="parameter_name"><p>stream_name</p></td>
1607+
<td class="parameter_description"><p>The name of the known module stream being added. </p></td>
1608+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
1609+
</tr>
1610+
</tbody>
1611+
</table></div>
1612+
</div>
1613+
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
1614+
</div>
15491615
</div>
15501616
<div class="refsect1">
15511617
<a name="modulemd-2.0-Modulemd.ModuleIndex.other_details"></a><h2>Types and Values</h2>

0 commit comments

Comments
 (0)