Updating libmodulemd docs for 33f0dbe64a6f71425e9d0e6c9674f4855b550d21

Author: sgallagher

libmodulemd/latest/ModulemdModuleStream.html

@@ -380,7 +380,17 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
                                   <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>,
                                   <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_stream</code></em>,
                                   <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>
+<div class="warning">
+<p><code class="literal">modulemd_module_stream_read_file</code> has been deprecated since version 2.11 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-file" title="modulemd_read_packager_file ()"><code class="function">modulemd_read_packager_file()</code></a> instead.</p>
+</div>
 <p>Create a <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> object from a YAML file.</p>
+<p>Note: This function also reads modulemd-packager v2 and v3 documents, which
+are transparently returned as <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> (V2) objects. However,
+if a modulemd-packager v3 document (<a class="link" href="modulemd-2.0-Modulemd.PackagerV3.html#ModulemdPackagerV3"><span class="type">ModulemdPackagerV3</span></a>) is encountered and
+it uses buildopts (<a class="link" href="modulemd-2.0-Modulemd.Buildopts.html#ModulemdBuildopts"><span class="type">ModulemdBuildopts</span></a>) in one or more build configurations,
+only the buildopts present in the first listed configuration (if any) will be
+applied to the returned <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> object.</p>
 <div class="refsect3">
 <a name="modulemd-module-stream-read-file.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -445,7 +455,17 @@ <h2><span class="refentrytitle"><a name="ModulemdModuleStream.top_of_page"></a>M
                                     <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>,
                                     <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_stream</code></em>,
                                     <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>
+<div class="warning">
+<p><code class="literal">modulemd_module_stream_read_string</code> has been deprecated since version 2.11 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string" title="modulemd_read_packager_string ()"><code class="function">modulemd_read_packager_string()</code></a> instead.</p>
+</div>
 <p>Create a <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> object from a YAML string.</p>
+<p>Note: This function also reads modulemd-packager v2 and v3 documents, which
+are transparently returned as <a class="link" href="ModulemdModuleStream.html" title="Modulemd.ModuleStream"><span class="type">ModulemdModuleStream</span></a> (V2) objects. However,
+if a modulemd-packager v3 document (<a class="link" href="modulemd-2.0-Modulemd.PackagerV3.html#ModulemdPackagerV3"><span class="type">ModulemdPackagerV3</span></a>) is encountered and
+it uses buildopts (<a class="link" href="modulemd-2.0-Modulemd.Buildopts.html#ModulemdBuildopts"><span class="type">ModulemdBuildopts</span></a>) in one or more build configurations,
+only the buildopts present in the first listed configuration (if any) will be
+applied to the returned <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> object.</p>
 <div class="refsect3">
 <a name="modulemd-module-stream-read-string.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">

libmodulemd/latest/ch01.html

@@ -27,6 +27,9 @@
 <span class="refentrytitle"><a href="modulemd-2.0-Modulemd.html">Modulemd</a></span><span class="refpurpose"> — User's Guide for libmodulemd</span>
 </dt>
 <dt>
+<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>
+</dt>
+<dt>
 <span class="refentrytitle"><a href="modulemd-2.0-Modulemd.Buildopts.html">Modulemd.Buildopts</a></span><span class="refpurpose"> — Provides hints to the build-system on how to build this module.</span>
 </dt>
 <dt>
@@ -78,6 +81,10 @@
 by a modulemd YAML document of version 2.</span>
 </dt>
 <dt>
+<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
+format.</span>
+</dt>
+<dt>
 <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>
 </dt>
 <dt>

libmodulemd/latest/ch02.html

@@ -7,7 +7,7 @@
 <link rel="home" href="index.html" title="Modulemd Reference Manual">
 <link rel="up" href="modulemd-2.0.html" title="libmodulemd">
 <link rel="prev" href="modulemd-2.0-Modulemd.Obsoletes.html" title="Modulemd.Obsoletes">
-<link rel="next" href="modulemd-2.0-Modulemd.BuildConfig.html" title="Modulemd.BuildConfig">
+<link rel="next" href="modulemd-2.0-modulemd-build-config-private.html" title="modulemd-build-config-private">
 <meta name="generator" content="GTK-Doc V1.32 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
@@ -17,14 +17,14 @@
 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 <td><a accesskey="u" href="modulemd-2.0.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 <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>
-<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>
+<td><a accesskey="n" href="modulemd-2.0-modulemd-build-config-private.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 </tr></table>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="id-1.2.4"></a>Modulemd 2.0 Private Object Methods</h2></div></div></div>
 <div class="toc"><dl class="toc">
 <dt>
-<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>
+<span class="refentrytitle"><a href="modulemd-2.0-modulemd-build-config-private.html">modulemd-build-config-private</a></span><span class="refpurpose"></span>
 </dt>
 <dt>
 <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
@@ -79,8 +79,8 @@
 used by internal consumers.</span>
 </dt>
 <dt>
-<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
-format.</span>
+<span class="refentrytitle"><a href="modulemd-2.0-Modulemd.PackagerV3-(Private).html">Modulemd.PackagerV3 (Private)</a></span><span class="refpurpose"> — <span class="type">ModulemdPackagerV3</span> methods that should only be used by
+internal consumers.</span>
 </dt>
 <dt>
 <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