Skip to content

Commit 42faa31

Browse files
sgallaghersgallagher
committed
Updating libmodulemd docs for 169136d708eb4df10e76247c5cc6189f0de0c13e
1 parent 2e08e8c commit 42faa31

File tree

4 files changed

+172
-0
lines changed

4 files changed

+172
-0
lines changed

‎libmodulemd/latest/ch16.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,9 +371,17 @@
371371
</dt>
372372
<dd></dd>
373373
<dt>
374+
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-file-ext" title="modulemd_read_packager_file_ext ()">modulemd_read_packager_file_ext</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
375+
</dt>
376+
<dd></dd>
377+
<dt>
374378
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string" title="modulemd_read_packager_string ()">modulemd_read_packager_string</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
375379
</dt>
376380
<dd></dd>
381+
<dt>
382+
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string-ext" title="modulemd_read_packager_string_ext ()">modulemd_read_packager_string_ext</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
383+
</dt>
384+
<dd></dd>
377385
</div>
378386
<div class="footer">
379387
<hr>Generated by GTK-Doc V1.32</div>

‎libmodulemd/latest/ch18.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2865,10 +2865,18 @@
28652865
</dt>
28662866
<dd></dd>
28672867
<dt>
2868+
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-file-ext" title="modulemd_read_packager_file_ext ()">modulemd_read_packager_file_ext</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
2869+
</dt>
2870+
<dd></dd>
2871+
<dt>
28682872
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string" title="modulemd_read_packager_string ()">modulemd_read_packager_string</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
28692873
</dt>
28702874
<dd></dd>
28712875
<dt>
2876+
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string-ext" title="modulemd_read_packager_string_ext ()">modulemd_read_packager_string_ext</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
2877+
</dt>
2878+
<dd></dd>
2879+
<dt>
28722880
<a class="link" href="modulemd-2.0-Modulemd-Utility-Functions.html#MODULEMD-REPLACE-SET:CAPS" title="MODULEMD_REPLACE_SET()">MODULEMD_REPLACE_SET</a>, macro in <a class="link" href="modulemd-2.0-Modulemd-Utility-Functions.html" title="Modulemd Utility Functions">Modulemd Utility Functions</a>
28732881
</dt>
28742882
<dd></dd>

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

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,25 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
8585
<a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
8686
</td>
8787
<td class="function_name">
88+
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-file-ext" title="modulemd_read_packager_file_ext ()">modulemd_read_packager_file_ext</a> <span class="c_punctuation">()</span>
89+
</td>
90+
</tr>
91+
<tr>
92+
<td class="function_type">
93+
<a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
94+
</td>
95+
<td class="function_name">
8896
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string" title="modulemd_read_packager_string ()">modulemd_read_packager_string</a> <span class="c_punctuation">()</span>
8997
</td>
9098
</tr>
99+
<tr>
100+
<td class="function_type">
101+
<a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
102+
</td>
103+
<td class="function_name">
104+
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-read-packager-string-ext" title="modulemd_read_packager_string_ext ()">modulemd_read_packager_string_ext</a> <span class="c_punctuation">()</span>
105+
</td>
106+
</tr>
91107
</tbody>
92108
</table></div>
93109
</div>
@@ -648,6 +664,7 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
648664
modulemd_read_packager_file (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *yaml_path</code></em>,
649665
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> **object</code></em>,
650666
<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>
667+
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
651668
<div class="refsect3">
652669
<a name="modulemd-read-packager-file.parameters"></a><h4>Parameters</h4>
653670
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -694,11 +711,80 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
694711
</div>
695712
<hr>
696713
<div class="refsect2">
714+
<a name="modulemd-read-packager-file-ext"></a><h3>modulemd_read_packager_file_ext ()</h3>
715+
<pre class="programlisting"><a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
716+
modulemd_read_packager_file_ext (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *yaml_path</code></em>,
717+
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> **object</code></em>,
718+
<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>,
719+
<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>,
720+
<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>
721+
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> modulemd_read_packager_file]</span></p>
722+
<div class="refsect3">
723+
<a name="modulemd-read-packager-file-ext.parameters"></a><h4>Parameters</h4>
724+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
725+
<colgroup>
726+
<col width="150px" class="parameters_name">
727+
<col class="parameters_description">
728+
<col width="200px" class="parameters_annotations">
729+
</colgroup>
730+
<tbody>
731+
<tr>
732+
<td class="parameter_name"><p>yaml_path</p></td>
733+
<td class="parameter_description"><p>A path to a YAML file containing a packager document. </p></td>
734+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
735+
</tr>
736+
<tr>
737+
<td class="parameter_name"><p>object</p></td>
738+
<td class="parameter_description"><p>(transfer full): A newly allocated <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> or
739+
<a class="link" href="modulemd-2.0-Modulemd.PackagerV3.html#ModulemdPackagerV3"><span class="type">ModulemdPackagerV3</span></a> object initialized with the content from <em class="parameter"><code>yaml_path</code></em>
740+
. </p></td>
741+
<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>
742+
</tr>
743+
<tr>
744+
<td class="parameter_name"><p>module_name</p></td>
745+
<td class="parameter_description"><p>An optional module name to override the
746+
document on disk. Mostly useful in cases where the name is being
747+
auto-detected from git. </p></td>
748+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
749+
</tr>
750+
<tr>
751+
<td class="parameter_name"><p>module_stream</p></td>
752+
<td class="parameter_description"><p>An optional module stream name to override
753+
the document on disk. Mostly useful in cases where the name is being
754+
auto-detected from git. </p></td>
755+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
756+
</tr>
757+
<tr>
758+
<td class="parameter_name"><p>error</p></td>
759+
<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> containing additional information if this function
760+
fails in a way that prevents program continuation. </p></td>
761+
<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>
762+
</tr>
763+
</tbody>
764+
</table></div>
765+
</div>
766+
<div class="refsect3">
767+
<a name="modulemd-read-packager-file-ext.returns"></a><h4>Returns</h4>
768+
<p> <em class="parameter"><code>MODULEMD_TYPE_MODULE_STREAM_V2</code></em>
769+
, <em class="parameter"><code>MODULEMD_TYPE_PACKAGER_V3</code></em>
770+
, or
771+
<em class="parameter"><code>G_TYPE_INVALID</code></em>
772+
. Returns the matching GObject through the <em class="parameter"><code>object</code></em>
773+
parameter.
774+
If the return value is <em class="parameter"><code>G_TYPE_INVALID</code></em>
775+
, returns the reason as <em class="parameter"><code>error</code></em>
776+
.</p>
777+
</div>
778+
<p class="since">Since: <a class="link" href="ch16.html#api-index-2.11">2.11</a></p>
779+
</div>
780+
<hr>
781+
<div class="refsect2">
697782
<a name="modulemd-read-packager-string"></a><h3>modulemd_read_packager_string ()</h3>
698783
<pre class="programlisting"><a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
699784
modulemd_read_packager_string (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *yaml_string</code></em>,
700785
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> **object</code></em>,
701786
<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>
787+
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
702788
<div class="refsect3">
703789
<a name="modulemd-read-packager-string.parameters"></a><h4>Parameters</h4>
704790
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -743,6 +829,74 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.top_of_page"></a>
743829
</div>
744830
<p class="since">Since: <a class="link" href="ch16.html#api-index-2.11">2.11</a></p>
745831
</div>
832+
<hr>
833+
<div class="refsect2">
834+
<a name="modulemd-read-packager-string-ext"></a><h3>modulemd_read_packager_string_ext ()</h3>
835+
<pre class="programlisting"><a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
836+
modulemd_read_packager_string_ext (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *yaml_string</code></em>,
837+
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> **object</code></em>,
838+
<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>,
839+
<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>,
840+
<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>
841+
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> modulemd_read_packager_string]</span></p>
842+
<div class="refsect3">
843+
<a name="modulemd-read-packager-string-ext.parameters"></a><h4>Parameters</h4>
844+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
845+
<colgroup>
846+
<col width="150px" class="parameters_name">
847+
<col class="parameters_description">
848+
<col width="200px" class="parameters_annotations">
849+
</colgroup>
850+
<tbody>
851+
<tr>
852+
<td class="parameter_name"><p>yaml_string</p></td>
853+
<td class="parameter_description"><p>A YAML string containing a packager document. </p></td>
854+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
855+
</tr>
856+
<tr>
857+
<td class="parameter_name"><p>object</p></td>
858+
<td class="parameter_description"><p>(transfer full): A newly allocated <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV2.html#ModulemdModuleStreamV2"><span class="type">ModulemdModuleStreamV2</span></a> or
859+
<a class="link" href="modulemd-2.0-Modulemd.PackagerV3.html#ModulemdPackagerV3"><span class="type">ModulemdPackagerV3</span></a> object initialized with the content from <em class="parameter"><code>yaml_string</code></em>
860+
. </p></td>
861+
<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>
862+
</tr>
863+
<tr>
864+
<td class="parameter_name"><p>module_name</p></td>
865+
<td class="parameter_description"><p>An optional module name to override the
866+
document on disk. Mostly useful in cases where the name is being
867+
auto-detected from git. </p></td>
868+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
869+
</tr>
870+
<tr>
871+
<td class="parameter_name"><p>module_stream</p></td>
872+
<td class="parameter_description"><p>An optional module stream name to override
873+
the document on disk. Mostly useful in cases where the name is being
874+
auto-detected from git. </p></td>
875+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
876+
</tr>
877+
<tr>
878+
<td class="parameter_name"><p>error</p></td>
879+
<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> containing additional information if this function
880+
fails in a way that prevents program continuation. </p></td>
881+
<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>
882+
</tr>
883+
</tbody>
884+
</table></div>
885+
</div>
886+
<div class="refsect3">
887+
<a name="modulemd-read-packager-string-ext.returns"></a><h4>Returns</h4>
888+
<p> <em class="parameter"><code>MODULEMD_TYPE_MODULE_STREAM_V2</code></em>
889+
, <em class="parameter"><code>MODULEMD_TYPE_PACKAGER_V3</code></em>
890+
, or
891+
<em class="parameter"><code>G_TYPE_INVALID</code></em>
892+
. Returns the matching GObject through the <em class="parameter"><code>object</code></em>
893+
parameter.
894+
If the return value is <em class="parameter"><code>G_TYPE_INVALID</code></em>
895+
, returns the reason as <em class="parameter"><code>error</code></em>
896+
.</p>
897+
</div>
898+
<p class="since">Since: <a class="link" href="ch16.html#api-index-2.11">2.11</a></p>
899+
</div>
746900
</div>
747901
</div>
748902
<div class="footer">

‎libmodulemd/latest/modulemd-2.0.devhelp2‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,9 @@
8484
<keyword type="function" name="modulemd_load_file ()" link="modulemd-2.0-Modulemd.html#modulemd-load-file" since="2.10"/>
8585
<keyword type="function" name="modulemd_load_string ()" link="modulemd-2.0-Modulemd.html#modulemd-load-string" since="2.10"/>
8686
<keyword type="function" name="modulemd_read_packager_file ()" link="modulemd-2.0-Modulemd.html#modulemd-read-packager-file" since="2.11"/>
87+
<keyword type="function" name="modulemd_read_packager_file_ext ()" link="modulemd-2.0-Modulemd.html#modulemd-read-packager-file-ext" since="2.11"/>
8788
<keyword type="function" name="modulemd_read_packager_string ()" link="modulemd-2.0-Modulemd.html#modulemd-read-packager-string" since="2.11"/>
89+
<keyword type="function" name="modulemd_read_packager_string_ext ()" link="modulemd-2.0-Modulemd.html#modulemd-read-packager-string-ext" since="2.11"/>
8890
<keyword type="function" name="modulemd_build_config_new ()" link="modulemd-2.0-Modulemd.BuildConfig.html#modulemd-build-config-new" since="2.11"/>
8991
<keyword type="function" name="modulemd_build_config_set_context ()" link="modulemd-2.0-Modulemd.BuildConfig.html#modulemd-build-config-set-context" since="2.11"/>
9092
<keyword type="function" name="modulemd_build_config_get_context ()" link="modulemd-2.0-Modulemd.BuildConfig.html#modulemd-build-config-get-context" since="2.11"/>

0 commit comments

Comments
 (0)