New upstream version 2021.2

apidoc/html/ostree-Core-repository-independent-functions.html

@@ -62,6 +62,14 @@
 </tr>
 <tr>
 <td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ostree-Core-repository-independent-functions.html#ostree-validate-collection-id" title="ostree_validate_collection_id ()">ostree_validate_collection_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
 <span class="returnvalue">guchar</span> *
 </td>
 <td class="function_name">
@@ -630,6 +638,56 @@ is a valid checksum string, <code class="literal">FALSE</code> otherwise</p>
 </div>
 <hr>
 <div class="refsect2">
+<a name="ostree-validate-collection-id"></a><h3>ostree_validate_collection_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+ostree_validate_collection_id (<em class="parameter"><code>const <span class="type">char</span> *collection_id</code></em>,
+                               <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>Check whether the given <em class="parameter"><code>collection_id</code></em>
+ is valid. Return an error if it is
+invalid or <code class="literal">NULL</code>.</p>
+<p>Valid collection IDs are reverse DNS names:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p>They are composed of 1 or more elements separated by a period (<code class="literal">.</code>) character.
+All elements must contain at least one character.</p></li>
+<li class="listitem"><p>Each element must only contain the ASCII characters <code class="literal">[A-Z][a-z][0-9]_</code> and must not
+begin with a digit.</p></li>
+<li class="listitem"><p>They must contain at least one <code class="literal">.</code> (period) character (and thus at least two elements).</p></li>
+<li class="listitem"><p>They must not begin with a <code class="literal">.</code> (period) character.</p></li>
+<li class="listitem"><p>They must not exceed 255 characters in length.</p></li>
+</ul></div>
+<p>(This makes their format identical to D-Bus interface names, for consistency.)</p>
+<div class="refsect3">
+<a name="ostree-validate-collection-id.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>collection_id</p></td>
+<td class="parameter_description"><p>A collection ID. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>Error</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="ostree-validate-collection-id.returns"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if <em class="parameter"><code>collection_id</code></em>
+is a valid collection ID, <code class="literal">FALSE</code> if it is invalid
+or <code class="literal">NULL</code></p>
+</div>
+<p class="since">Since: 2018.6</p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="ostree-checksum-to-bytes"></a><h3>ostree_checksum_to_bytes ()</h3>
 <pre class="programlisting"><span class="returnvalue">guchar</span> *
 ostree_checksum_to_bytes (<em class="parameter"><code>const <span class="type">char</span> *checksum</code></em>);</pre>