Skip to content

Commit 1f2d268

Browse files
author
Libmodulemd CI
committed
Updating libmodulemd docs for f2d750152c655c1ff055bfe6ce961c48b8871a41
Signed-off-by: Libmodulemd CI <[email protected]>
1 parent 886a8be commit 1f2d268

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

libmodulemd/latest/modulemd-2.0-Modulemd.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
118118
will assume that the content of the YAML module metadata from those two
119119
repositories have been loaded into string variables <code class="literal">fedora_yaml</code> and
120120
<code class="literal">updates_yaml</code>, respectively.</p>
121+
<p>Tools such as DNF that are consuming data from a repository should always
122+
set <code class="literal">strict=False</code>, so that it can safely handle minor,
123+
backwards-compatible changes to the modulemd format.</p>
121124
<p>First step is to load the metadata from these two repositories into
122125
<a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a> objects. This is done as follows:</p>
123126
<p>In C:</p>
@@ -134,11 +137,11 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
134137
7</pre></td>
135138
<td class="listing_code"><pre class="programlisting"><span class="n">ModulemdModuleIndex</span> <span class="o">*</span><span class="n">fedora_index</span> <span class="o">=</span> <span class="n">modulemd_module_index_new</span> <span class="p">();</span>
136139
<span class="n">gboolean</span> <span class="n">ret</span> <span class="o">=</span> <span class="n">modulemd_module_index_update_from_string</span> <span class="p">(</span>
137-
<span class="n">fedora_index</span><span class="p">,</span> <span class="n">fedora_yaml</span><span class="p">,</span> <span class="n">TRUE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">failures</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">error</span><span class="p">);</span>
140+
<span class="n">fedora_index</span><span class="p">,</span> <span class="n">fedora_yaml</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">failures</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">error</span><span class="p">);</span>
138141

139142
<span class="n">ModulemdModuleIndex</span> <span class="o">*</span><span class="n">updates_index</span> <span class="o">=</span> <span class="n">modulemd_module_index_new</span> <span class="p">();</span>
140143
<span class="n">gboolean</span> <span class="n">ret2</span> <span class="o">=</span> <span class="n">modulemd_module_index_update_from_string</span> <span class="p">(</span>
141-
<span class="n">updates_index</span><span class="p">,</span> <span class="n">updates_yaml</span><span class="p">,</span> <span class="n">TRUE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">failures</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">error</span><span class="p">);</span></pre></td>
144+
<span class="n">updates_index</span><span class="p">,</span> <span class="n">updates_yaml</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">failures</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">error</span><span class="p">);</span></pre></td>
142145
</tr>
143146
</tbody>
144147
</table>
@@ -156,10 +159,10 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
156159
4
157160
5</pre></td>
158161
<td class="listing_code"><pre class="programlisting"><span class="n">fedora_index</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>
159-
<span class="n">ret</span><span class="p">,</span> <span class="n">failures</span> <span class="o">=</span> <span class="n">fedora_index</span><span class="p">.</span><span class="n">update_from_string</span><span class="p">(</span><span class="n">fedora_yaml</span><span class="p">,</span> <span class="n">True</span><span class="p">)</span>
162+
<span class="n">ret</span><span class="p">,</span> <span class="n">failures</span> <span class="o">=</span> <span class="n">fedora_index</span><span class="p">.</span><span class="n">update_from_string</span><span class="p">(</span><span class="n">fedora_yaml</span><span class="p">,</span> <span class="n">False</span><span class="p">)</span>
160163

161164
<span class="n">updates_index</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>
162-
<span class="n">ret</span><span class="p">,</span> <span class="n">failures</span> <span class="o">=</span> <span class="n">updates_index</span><span class="p">.</span><span class="n">update_from_string</span><span class="p">(</span><span class="n">updates_yaml</span><span class="p">,</span> <span class="n">True</span><span class="p">)</span></pre></td>
165+
<span class="n">ret</span><span class="p">,</span> <span class="n">failures</span> <span class="o">=</span> <span class="n">updates_index</span><span class="p">.</span><span class="n">update_from_string</span><span class="p">(</span><span class="n">updates_yaml</span><span class="p">,</span> <span class="n">False</span><span class="p">)</span></pre></td>
163166
</tr>
164167
</tbody>
165168
</table>
@@ -234,7 +237,7 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
234237
give only a brief overview of the most common operations. See the API
235238
specification for a full list of information that can be retrieved.</p>
236239
<div class="refsect3">
237-
<a name="id-1.2.3.2.5.2.20"></a><h4>Discover the default stream for a particular module.</h4>
240+
<a name="id-1.2.3.2.5.2.21"></a><h4>Discover the default stream for a particular module.</h4>
238241
<p>In C:</p>
239242
<div class="informalexample">
240243
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
@@ -283,7 +286,7 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
283286
<p></p>
284287
</div>
285288
<div class="refsect3">
286-
<a name="id-1.2.3.2.5.2.21"></a><h4>Get the list of RPMs defining the public API for a particular module NSVCA</h4>
289+
<a name="id-1.2.3.2.5.2.22"></a><h4>Get the list of RPMs defining the public API for a particular module NSVCA</h4>
287290
<p>First, query the <a class="link" href="modulemd-2.0-Modulemd.ModuleIndex.html#ModulemdModuleIndex"><span class="type">ModulemdModuleIndex</span></a> for the module with a given name.</p>
288291
<p>In C:</p>
289292
<div class="informalexample">
@@ -415,7 +418,7 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
415418
<p></p>
416419
</div>
417420
<div class="refsect3">
418-
<a name="id-1.2.3.2.5.2.22"></a><h4>Retrieve the modular runtime dependencies for a particular module NSVCA</h4>
421+
<a name="id-1.2.3.2.5.2.23"></a><h4>Retrieve the modular runtime dependencies for a particular module NSVCA</h4>
419422
<p>In C:</p>
420423
<div class="informalexample">
421424
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">

0 commit comments

Comments
 (0)