New upstream version 2018.2

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

@@ -419,6 +419,14 @@
 </tr>
 <tr>
 <td class="function_type">
+<span class="returnvalue">gchar</span> *
+</td>
+<td class="function_name">
+<a class="link" href="ostree-Core-repository-independent-functions.html#ostree-commit-get-content-checksum" title="ostree_commit_get_content_checksum ()">ostree_commit_get_content_checksum</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
 <span class="returnvalue">gboolean</span>
 </td>
 <td class="function_name">
@@ -1044,14 +1052,15 @@ ostree_parse_refspec (<em class="parameter"><code>const <span class="type">char<
                       <em class="parameter"><code><span class="type">char</span> **out_remote</code></em>,
                       <em class="parameter"><code><span class="type">char</span> **out_ref</code></em>,
                       <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
-<p>Split a refspec like "gnome-ostree:gnome-ostree/buildmaster" into
-two parts; <em class="parameter"><code>out_remote</code></em>
- will be set to "gnome-ostree", and <em class="parameter"><code>out_ref</code></em>
+<p>Split a refspec like <code class="literal">gnome-ostree:gnome-ostree/buildmaster</code> or just
+<code class="literal">gnome-ostree/buildmaster</code> into two parts. In the first case, <em class="parameter"><code>out_remote</code></em>
 
-will be "gnome-ostree/buildmaster".</p>
-<p>If <em class="parameter"><code>refspec</code></em>
- refers to a local ref, <em class="parameter"><code>out_remote</code></em>
- will be <code class="literal">NULL</code>.</p>
+will be set to <code class="literal">gnome-ostree</code>, and <em class="parameter"><code>out_ref</code></em>
+ to <code class="literal">gnome-ostree/buildmaster</code>.
+In the second case (a local ref), <em class="parameter"><code>out_remote</code></em>
+ will be <code class="literal">NULL</code>, and <em class="parameter"><code>out_ref</code></em>
+
+will be <code class="literal">gnome-ostree/buildmaster</code>. In both cases, <code class="literal">TRUE</code> will be returned.</p>
 <div class="refsect3">
 <a name="ostree-parse-refspec.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
@@ -1068,13 +1077,14 @@ will be "gnome-ostree/buildmaster".</p>
 </tr>
 <tr>
 <td class="parameter_name"><p>out_remote</p></td>
-<td class="parameter_description"><p>The remote name, or <code class="literal">NULL</code> if the refspec refs to a local ref. </p></td>
-<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
+<td class="parameter_description"><p>Return location for the remote name,
+or <code class="literal">NULL</code> if the refspec refs to a local ref. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>][<a href="http://foldoc.org/optional"><span class="acronym">optional</span></a>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>out_ref</p></td>
-<td class="parameter_description"><p>Name of ref. </p></td>
-<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
+<td class="parameter_description"><p>Return location for the ref name. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/not%20nullable"><span class="acronym">not nullable</span></a>][<a href="http://foldoc.org/optional"><span class="acronym">optional</span></a>]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>error</p></td>
@@ -1084,6 +1094,10 @@ will be "gnome-ostree/buildmaster".</p>
 </tbody>
 </table></div>
 </div>
+<div class="refsect3">
+<a name="ostree-parse-refspec.returns"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> on successful parsing, <code class="literal">FALSE</code> otherwise</p>
+</div>
 </div>
 <hr>
 <div class="refsect2">
@@ -2332,6 +2346,42 @@ ostree_commit_get_timestamp (<em class="parameter"><code><span class="type">GVar
 </div>
 <hr>
 <div class="refsect2">
+<a name="ostree-commit-get-content-checksum"></a><h3>ostree_commit_get_content_checksum ()</h3>
+<pre class="programlisting"><span class="returnvalue">gchar</span> *
+ostree_commit_get_content_checksum (<em class="parameter"><code><span class="type">GVariant</span> *commit_variant</code></em>);</pre>
+<p>There are use cases where one wants a checksum just of the content of a
+commit. OSTree commits by default capture the current timestamp, and may have
+additional metadata, which means that re-committing identical content
+often results in a new checksum.</p>
+<p>By comparing checksums of content, it's possible to easily distinguish
+cases where nothing actually changed.</p>
+<p>The content checksums is simply defined as <code class="literal">SHA256(root dirtree_checksum || root_dirmeta_checksum)</code>,
+i.e. the SHA-256 of the root "dirtree" object's checksum concatenated with the
+root "dirmeta" checksum (both in binary form, not hexadecimal).</p>
+<div class="refsect3">
+<a name="ostree-commit-get-content-checksum.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>commit_variant</p></td>
+<td class="parameter_description"><p>A commit object</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="ostree-commit-get-content-checksum.returns"></a><h4>Returns</h4>
+<p>A SHA-256 hex string, or <code class="literal">NULL</code> if <em class="parameter"><code>commit_variant</code></em>
+is not well-formed. </p>
+<p><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
 <a name="ostree-check-version"></a><h3>ostree_check_version ()</h3>
 <pre class="programlisting"><span class="returnvalue">gboolean</span>
 ostree_check_version (<em class="parameter"><code><span class="type">guint</span> required_year</code></em>,