Skip to content

Commit cc15fef

Browse files
author
Libmodulemd CI
committed
Updating libmodulemd docs for 7839a46a8cc9af0f6d18028aaff2b66ba3539d18
Signed-off-by: Libmodulemd CI <[email protected]>
1 parent 68f21b5 commit cc15fef

File tree

1 file changed

+70
-35
lines changed

1 file changed

+70
-35
lines changed

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

Lines changed: 70 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,8 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
485485
</tr>
486486
<tr>
487487
<td class="parameter_name"><p>yaml_file</p></td>
488-
<td class="parameter_description"><p>A YAML file containing the module metadata and other
489-
related information such as default streams. </p></td>
488+
<td class="parameter_description"><p>A name of a YAML file containing the module metadata and
489+
other related information such as default streams. </p></td>
490490
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
491491
</tr>
492492
<tr>
@@ -497,25 +497,33 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
497497
</tr>
498498
<tr>
499499
<td class="parameter_name"><p>failures</p></td>
500-
<td class="parameter_description"><p>An array containing any subdocuments from the YAML file that failed to parse.
501-
See <a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a> for more details. </p></td>
500+
<td class="parameter_description"><p>On output, an array containing any subdocuments (pointers to
501+
<a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a>) from the YAML file that failed to parse. On
502+
input, it must be a non-<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer. If that pointer points to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, this
503+
call will allocate a new array (regardless of any failures) with an element
504+
destructor set to <a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. Otherwise, the pointed array is reused
505+
without emptying before adding the failed subdocuments. The caller is
506+
responsible for freeing the array. </p></td>
502507
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ModulemdSubdocumentInfo][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></td>
503508
</tr>
504509
<tr>
505510
<td class="parameter_name"><p>error</p></td>
506511
<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
507-
fails in a way that prevents program continuation. </p></td>
512+
fails in a way that prevents program continuation. On input, it must be
513+
<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you don't care) or a pointer to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you want to know the
514+
error). On output, it will become allocated only if an error occured. </p></td>
508515
<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>
509516
</tr>
510517
</tbody>
511518
</table></div>
512519
</div>
513520
<div class="refsect3">
514521
<a name="modulemd-module-index-update-from-file.returns"></a><h4>Returns</h4>
515-
<p> TRUE if the update was successful. Returns FALSE and sets <em class="parameter"><code>failures</code></em>
516-
appropriately if any of the YAML subdocuments were invalid or sets <em class="parameter"><code>error</code></em>
517-
if
518-
there was a fatal parse error.</p>
522+
<p> <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the update was successful. Returns <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and sets
523+
<em class="parameter"><code>failures</code></em>
524+
appropriately if any of the YAML subdocuments were invalid or
525+
sets <em class="parameter"><code>error</code></em>
526+
if there was a fatal parse error.</p>
519527
</div>
520528
<p class="since">Since: <a class="link" href="ch05.html#api-index-2.0">2.0</a></p>
521529
</div>
@@ -557,25 +565,33 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
557565
</tr>
558566
<tr>
559567
<td class="parameter_name"><p>failures</p></td>
560-
<td class="parameter_description"><p>An array containing any subdocuments from the YAML file that failed to parse.
561-
See <a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a> for more details. </p></td>
568+
<td class="parameter_description"><p>On output, an array containing any subdocuments (pointers to
569+
<a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a>) from the YAML file that failed to parse. On
570+
input, it must be a non-<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer. If that pointer points to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, this
571+
call will allocate a new array (regardless of any failures) with an element
572+
destructor set to <a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. Otherwise, the pointed array is reused
573+
without emptying before adding the failed subdocuments. The caller is
574+
responsible for freeing the array. </p></td>
562575
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ModulemdSubdocumentInfo][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></td>
563576
</tr>
564577
<tr>
565578
<td class="parameter_name"><p>error</p></td>
566579
<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
567-
fails in a way that prevents program continuation. </p></td>
580+
fails in a way that prevents program continuation. On input, it must be
581+
<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you don't care) or a pointer to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you want to know the
582+
error). On output, it will become allocated only if an error occured. </p></td>
568583
<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>
569584
</tr>
570585
</tbody>
571586
</table></div>
572587
</div>
573588
<div class="refsect3">
574589
<a name="modulemd-module-index-update-from-string.returns"></a><h4>Returns</h4>
575-
<p> TRUE if the update was successful. Returns FALSE and sets <em class="parameter"><code>failures</code></em>
576-
appropriately if any of the YAML subdocuments were invalid or sets <em class="parameter"><code>error</code></em>
577-
if
578-
there was a fatal parse error.</p>
590+
<p> <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the update was successful. Returns <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and sets
591+
<em class="parameter"><code>failures</code></em>
592+
appropriately if any of the YAML subdocuments were invalid or
593+
sets <em class="parameter"><code>error</code></em>
594+
if there was a fatal parse error.</p>
579595
</div>
580596
<p class="since">Since: <a class="link" href="ch05.html#api-index-2.0">2.0</a></p>
581597
</div>
@@ -618,25 +634,33 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
618634
</tr>
619635
<tr>
620636
<td class="parameter_name"><p>failures</p></td>
621-
<td class="parameter_description"><p>An array containing any subdocuments from the YAML file that failed to parse.
622-
See <a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a> for more details. </p></td>
637+
<td class="parameter_description"><p>On output, an array containing any subdocuments (pointers to
638+
<a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a>) from the YAML file that failed to parse. On
639+
input, it must be a non-<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer. If that pointer points to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, this
640+
call will allocate a new array (regardless of any failures) with an element
641+
destructor set to <a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. Otherwise, the pointed array is reused
642+
without emptying before adding the failed subdocuments. The caller is
643+
responsible for freeing the array. </p></td>
623644
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ModulemdSubdocumentInfo][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></td>
624645
</tr>
625646
<tr>
626647
<td class="parameter_name"><p>error</p></td>
627648
<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
628-
fails in a way that prevents program continuation. </p></td>
649+
fails in a way that prevents program continuation. On input, it must be
650+
<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you don't care) or a pointer to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you want to know the
651+
error). On output, it will become allocated only if an error occured. </p></td>
629652
<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>
630653
</tr>
631654
</tbody>
632655
</table></div>
633656
</div>
634657
<div class="refsect3">
635658
<a name="modulemd-module-index-update-from-stream.returns"></a><h4>Returns</h4>
636-
<p> TRUE if the update was successful. Returns FALSE and sets <em class="parameter"><code>failures</code></em>
637-
appropriately if any of the YAML subdocuments were invalid or sets <em class="parameter"><code>error</code></em>
638-
if
639-
there was a fatal parse error.</p>
659+
<p> <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the update was successful. Returns <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and sets
660+
<em class="parameter"><code>failures</code></em>
661+
appropriately if any of the YAML subdocuments were invalid or
662+
sets <em class="parameter"><code>error</code></em>
663+
if there was a fatal parse error.</p>
640664
</div>
641665
<p class="since">Since: <a class="link" href="ch05.html#api-index-2.0">2.0</a></p>
642666
</div>
@@ -684,25 +708,33 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
684708
</tr>
685709
<tr>
686710
<td class="parameter_name"><p>failures</p></td>
687-
<td class="parameter_description"><p>An array containing any subdocuments from the YAML file that failed to parse.
688-
See <a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a> for more details. </p></td>
711+
<td class="parameter_description"><p>On output, an array containing any subdocuments (pointers to
712+
<a class="link" href="modulemd-2.0-Modulemd.SubdocumentInfo.html#ModulemdSubdocumentInfo"><span class="type">ModulemdSubdocumentInfo</span></a>) from the YAML file that failed to parse. On
713+
input, it must be a non-<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer. If that pointer points to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, this
714+
call will allocate a new array (regardless of any failures) with an element
715+
destructor set to <a href="https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. Otherwise, the pointed array is reused
716+
without emptying before adding the failed subdocuments. The caller is
717+
responsible for freeing the array. </p></td>
689718
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ModulemdSubdocumentInfo][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></td>
690719
</tr>
691720
<tr>
692721
<td class="parameter_name"><p>error</p></td>
693722
<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
694-
fails in a way that prevents program continuation. </p></td>
723+
fails in a way that prevents program continuation. On input, it must be
724+
<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you don't care) or a pointer to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you want to know the
725+
error). On output, it will become allocated only if an error occured. </p></td>
695726
<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>
696727
</tr>
697728
</tbody>
698729
</table></div>
699730
</div>
700731
<div class="refsect3">
701732
<a name="modulemd-module-index-update-from-custom.returns"></a><h4>Returns</h4>
702-
<p> TRUE if the update was successful. Returns FALSE and sets <em class="parameter"><code>failures</code></em>
703-
appropriately if any of the YAML subdocuments were invalid or sets <em class="parameter"><code>error</code></em>
704-
if
705-
there was a fatal parse error.</p>
733+
<p> <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the update was successful. Returns <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and sets
734+
<em class="parameter"><code>failures</code></em>
735+
appropriately if any of the YAML subdocuments were invalid or
736+
sets <em class="parameter"><code>error</code></em>
737+
if there was a fatal parse error.</p>
706738
</div>
707739
<p class="since">Since: <a class="link" href="ch08.html#api-index-2.3">2.3</a></p>
708740
</div>
@@ -721,7 +753,7 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
721753
adding any files with the suffix ".yaml" to <em class="parameter"><code>self</code></em>
722754
. If <em class="parameter"><code>overrides_path</code></em>
723755
is
724-
non-NULL, it will also open any files with the suffix ".yaml" in that
756+
non-<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, it will also open any files with the suffix ".yaml" in that
725757
location and import them, overriding any conflicts with the existing
726758
defaults.</p>
727759
<p>Note: If you need detailed information about what failed and why, it is
@@ -755,23 +787,26 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleIndex.top_o
755787
</tr>
756788
<tr>
757789
<td class="parameter_name"><p>overrides_path</p></td>
758-
<td class="parameter_description"><p>If non-NULL, the path to a directory
790+
<td class="parameter_description"><p>If non-<a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the path to a directory
759791
containing defaults documents that should override those in <em class="parameter"><code>path</code></em>
760792
. </p></td>
761793
<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>
762794
</tr>
763795
<tr>
764796
<td class="parameter_name"><p>error</p></td>
765-
<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> indicating why this function failed. </p></td>
797+
<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> indicating why this function failed. On input, it
798+
must be <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you don't care) or a pointer to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if you want to
799+
know the error). On output, it will become allocated only if an error
800+
occured. </p></td>
766801
<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>
767802
</tr>
768803
</tbody>
769804
</table></div>
770805
</div>
771806
<div class="refsect3">
772807
<a name="modulemd-module-index-update-from-defaults-directory.returns"></a><h4>Returns</h4>
773-
<p> TRUE if all ".yaml" files in the directory were imported
774-
successfully (this includes if no ".yaml" files were present). FALSE if one
808+
<p> <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if all ".yaml" files in the directory were imported
809+
successfully (this includes if no ".yaml" files were present). <a href="https://developer.gnome.org/glib/stable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if one
775810
or more files could not be read successfully and sets <em class="parameter"><code>error</code></em>
776811
appropriately.</p>
777812
</div>

0 commit comments

Comments
 (0)