New upstream version 2017.8
This commit is contained in:
commit
b6c0af922c
158 files changed
+12692
-2420
No files matched your search
@@ -14,7 +14,7 @@
|
||||
<div class="titlepage">
|
||||
<div>
|
||||
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">OSTree API references</p></th></tr></table></div>
|
||||
<div><p class="releaseinfo">for OSTree 2017.7</p></div>
|
||||
<div><p class="releaseinfo">for OSTree 2017.8</p></div>
|
||||
</div>
|
||||
<hr>
|
||||
</div>
|
||||
|
||||
@@ -1130,6 +1130,22 @@ filesystem and write content, possibly multiple times.</p>
|
||||
<p>Once the <a class="link" href="ostree-In-memory-modifiable-filesystem-tree.html#OstreeMutableTree" title="OstreeMutableTree"><span class="type">OstreeMutableTree</span></a> is complete, write all of its metadata
|
||||
with <a class="link" href="ostree-Content-addressed-object-store.html#ostree-repo-write-mtree" title="ostree_repo_write_mtree ()"><code class="function">ostree_repo_write_mtree()</code></a>, and finally create a commit with
|
||||
<a class="link" href="ostree-Content-addressed-object-store.html#ostree-repo-write-commit" title="ostree_repo_write_commit ()"><code class="function">ostree_repo_write_commit()</code></a>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="id-1.2.3.5.7"></a><h4>Collection IDs</h4>
|
||||
<p>A collection ID is a globally unique identifier which, if set, is used to
|
||||
identify refs from a repository which are mirrored elsewhere, such as in
|
||||
mirror repositories or peer to peer networks.</p>
|
||||
<p>This is separate from the <code class="literal">collection-id</code> configuration key for a remote, which
|
||||
is used to store the collection ID of the repository that remote points to.</p>
|
||||
<p>The collection ID should only be set on an <a class="link" href="ostree-Content-addressed-object-store.html#OstreeRepo" title="OstreeRepo"><span class="type">OstreeRepo</span></a> if it is the canonical
|
||||
collection for some refs.</p>
|
||||
<p>A collection ID must be a reverse DNS name, where the domain name is under the
|
||||
control of the curator of the collection, so they can demonstrate ownership
|
||||
of the collection. The later elements in the reverse DNS name can be used to
|
||||
disambiguate between multiple collections from the same curator. For example,
|
||||
<code class="literal">org.exampleos.Main</code> and <code class="literal">org.exampleos.Apps</code>. For the complete format of
|
||||
collection IDs, see <code class="function">ostree_validate_collection_id()</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="ostree-Content-addressed-object-store.functions_details"></a><h2>Functions</h2>
|
||||
@@ -6325,6 +6341,9 @@ ostree_repo_pull_with_options (<em class="parameter"><code><a class="link" href=
|
||||
The following are currently defined:</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
||||
<li class="listitem"><p>refs (as): Array of string refs</p></li>
|
||||
<li class="listitem"><p>collection-refs (a(sss)): Array of (collection ID, ref name, checksum) tuples to pull;
|
||||
mutually exclusive with <code class="literal">refs</code> and <code class="literal">override-commit-ids</code>. Checksums may be the empty
|
||||
string to pull the latest commit for that ref</p></li>
|
||||
<li class="listitem"><p>flags (i): An instance of <a class="link" href="ostree-Content-addressed-object-store.html#OstreeRepoPullFlags" title="enum OstreeRepoPullFlags"><span class="type">OstreeRepoPullFlags</span></a></p></li>
|
||||
<li class="listitem"><p>subdir (s): Pull just this subdirectory</p></li>
|
||||
<li class="listitem"><p>subdirs (as): Pull just these subdirectories</p></li>
|
||||
@@ -6340,6 +6359,7 @@ The following are currently defined:</p>
|
||||
<li class="listitem"><p>inherit-transaction (b): Don't initiate, finish or abort a transaction, useful to do multiple pulls in one transaction.</p></li>
|
||||
<li class="listitem"><p>http-headers (a(ss)): Additional headers to add to all HTTP requests</p></li>
|
||||
<li class="listitem"><p>update-frequency (u): Frequency to call the async progress callback in milliseconds, if any; only values higher than 0 are valid</p></li>
|
||||
<li class="listitem"><p>localcache-repos (as): File paths for local repos to use as caches when doing remote fetches</p></li>
|
||||
</ul></div>
|
||||
<div class="refsect3">
|
||||
<a name="ostree-repo-pull-with-options.parameters"></a><h4>Parameters</h4>
|
||||
@@ -6537,7 +6557,7 @@ ostree_repo_add_gpg_signature_summary (<em class="parameter"><code><a class="lin
|
||||
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *homedir</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||||
<p>Add a GPG signature to a static delta.</p>
|
||||
<p>Add a GPG signature to a summary file.</p>
|
||||
<div class="refsect3">
|
||||
<a name="ostree-repo-add-gpg-signature-summary.parameters"></a><h4>Parameters</h4>
|
||||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||||
@@ -6911,6 +6931,12 @@ regular, setting the <code class="literal">ostree.summary.expires</code> key in
|
||||
will aid clients in working out when to check for updates.</p>
|
||||
<p>It is regenerated automatically after a commit if
|
||||
<code class="literal">core/commit-update-summary</code> is set.</p>
|
||||
<p>If the <code class="literal">core/collection-id</code> key is set in the configuration, it will be
|
||||
included as <code class="literal">OSTREE_SUMMARY_COLLECTION_ID</code> in the summary file. Refs from the
|
||||
<code class="literal">refs/mirrors</code> directory will be included in the generated summary file,
|
||||
listed under the <code class="literal">OSTREE_SUMMARY_COLLECTION_MAP</code> key. Collection IDs and refs
|
||||
in <code class="literal">OSTREE_SUMMARY_COLLECTION_MAP</code> are guaranteed to be in lexicographic
|
||||
order.</p>
|
||||
<div class="refsect3">
|
||||
<a name="ostree-repo-regenerate-summary.parameters"></a><h4>Parameters</h4>
|
||||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||||
|
||||
@@ -175,6 +175,14 @@
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="ostree-Core-repository-independent-functions.html#ostree-validate-remote-name" title="ostree_validate_remote_name ()">ostree_validate_remote_name</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="ostree-Core-repository-independent-functions.html#ostree-parse-refspec" title="ostree_parse_refspec ()">ostree_parse_refspec</a> <span class="c_punctuation">()</span>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -979,6 +987,41 @@ is a valid ref string</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="ostree-validate-remote-name"></a><h3>ostree_validate_remote_name ()</h3>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
ostree_validate_remote_name (<em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||||
<div class="refsect3">
|
||||
<a name="ostree-validate-remote-name.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>remote_name</p></td>
|
||||
<td class="parameter_description"><p>A remote name</p></td>
|
||||
<td class="parameter_annotations"> </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-remote-name.returns"></a><h4>Returns</h4>
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>remote_name</code></em>
|
||||
is a valid remote name</p>
|
||||
</div>
|
||||
<p class="since">Since: 2017.8</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="ostree-parse-refspec"></a><h3>ostree_parse_refspec ()</h3>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
ostree_parse_refspec (<em class="parameter"><code>const <span class="type">char</span> *refspec</code></em>,
|
||||
|
||||
@@ -37,6 +37,7 @@
|
||||
<keyword type="function" name="ostree_checksum_b64_inplace_to_bytes ()" link="ostree-Core-repository-independent-functions.html#ostree-checksum-b64-inplace-to-bytes"/>
|
||||
<keyword type="function" name="ostree_cmp_checksum_bytes ()" link="ostree-Core-repository-independent-functions.html#ostree-cmp-checksum-bytes"/>
|
||||
<keyword type="function" name="ostree_validate_rev ()" link="ostree-Core-repository-independent-functions.html#ostree-validate-rev"/>
|
||||
<keyword type="function" name="ostree_validate_remote_name ()" link="ostree-Core-repository-independent-functions.html#ostree-validate-remote-name" since="2017.8"/>
|
||||
<keyword type="function" name="ostree_parse_refspec ()" link="ostree-Core-repository-independent-functions.html#ostree-parse-refspec"/>
|
||||
<keyword type="function" name="ostree_object_type_to_string ()" link="ostree-Core-repository-independent-functions.html#ostree-object-type-to-string"/>
|
||||
<keyword type="function" name="ostree_object_type_from_string ()" link="ostree-Core-repository-independent-functions.html#ostree-object-type-from-string"/>
|
||||
|
||||
@@ -1481,6 +1481,10 @@ OSTREE_RELEASE_VERSION, macro in ostree-version
|
||||
</dt>
|
||||
<dd></dd>
|
||||
<dt>
|
||||
<a class="link" href="ostree-Core-repository-independent-functions.html#ostree-validate-remote-name" title="ostree_validate_remote_name ()">ostree_validate_remote_name</a>, function in <a class="link" href="ostree-Core-repository-independent-functions.html" title="Core repository-independent functions">Core repository-independent functions</a>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
<dt>
|
||||
<a class="link" href="ostree-Core-repository-independent-functions.html#ostree-validate-rev" title="ostree_validate_rev ()">ostree_validate_rev</a>, function in <a class="link" href="ostree-Core-repository-independent-functions.html" title="Core repository-independent functions">Core repository-independent functions</a>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
|
||||
Reference in new issue
Block a user