Merge pull request #392 from mattdangerw/doc-update

Update documentation to 0.6.13
This commit is contained in:
matthiasclasen
2016-11-02 21:20:36 -04:00
committed by GitHub
6 changed files with 469 additions and 187 deletions

View File

File diff suppressed because one or more lines are too long

View File

@@ -257,6 +257,14 @@
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="FlatpakInstallation.html#flatpak-installation-update-remote-sync" title="flatpak_installation_update_remote_sync ()">flatpak_installation_update_remote_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
@@ -305,7 +313,7 @@
should use to operate on an flatpak applications.</p>
<p>An FlatpakInstallation object provides information about an installation
location for flatpak applications. Typical installation locations are either
system-wide (in /var/lib/flatpak) or per-user (in ~/.local/share/flatpak).</p>
system-wide (in $prefix/var/lib/flatpak) or per-user (in ~/.local/share/flatpak).</p>
<p>FlatpakInstallation can list configured remotes as well as installed application
and runtime references (in short: refs). It can also run, install, update and
uninstall applications and runtimes.</p>
@@ -1741,6 +1749,56 @@ flatpak_installation_remove_remote (<em class="parameter"><code><a class="link"
</div>
<hr>
<div class="refsect2">
<a name="flatpak-installation-update-remote-sync"></a><h3>flatpak_installation_update_remote_sync ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
flatpak_installation_update_remote_sync
(<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Updates the local configuration of a remote repository by fetching
the related information from the summary file in the remote OSTree
repository and committing the changes to the local installation.</p>
<div class="refsect3">
<a name="flatpak-installation-update-remote-sync.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name of the remote to update</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="flatpak-installation-update-remote-sync.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the remote has been updated successfully</p>
</div>
<p class="since">Since: 0.6.13</p>
</div>
<hr>
<div class="refsect2">
<a name="flatpak-get-default-arch"></a><h3>flatpak_get_default_arch ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
flatpak_get_default_arch (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>

View File

@@ -81,7 +81,7 @@
<hr>
<div class="refsect2">
<a name="FLATPAK-MICRO-VERSION:CAPS"></a><h3>FLATPAK_MICRO_VERSION</h3>
<pre class="programlisting">#define FLATPAK_MICRO_VERSION (7)
<pre class="programlisting">#define FLATPAK_MICRO_VERSION (13)
</pre>
</div>
<hr>

View File

@@ -43,6 +43,7 @@
<keyword type="function" name="flatpak_installation_drop_caches ()" link="FlatpakInstallation.html#flatpak-installation-drop-caches"/>
<keyword type="function" name="flatpak_installation_modify_remote ()" link="FlatpakInstallation.html#flatpak-installation-modify-remote"/>
<keyword type="function" name="flatpak_installation_remove_remote ()" link="FlatpakInstallation.html#flatpak-installation-remove-remote"/>
<keyword type="function" name="flatpak_installation_update_remote_sync ()" link="FlatpakInstallation.html#flatpak-installation-update-remote-sync" since="0.6.13"/>
<keyword type="function" name="flatpak_get_default_arch ()" link="FlatpakInstallation.html#flatpak-get-default-arch"/>
<keyword type="function" name="FlatpakProgressCallback ()" link="FlatpakInstallation.html#FlatpakProgressCallback"/>
<keyword type="struct" name="struct FlatpakInstallation" link="FlatpakInstallation.html#FlatpakInstallation-struct"/>

View File

@@ -209,6 +209,10 @@
</dt>
<dd></dd>
<dt>
<a class="link" href="FlatpakInstallation.html#flatpak-installation-update-remote-sync" title="flatpak_installation_update_remote_sync ()">flatpak_installation_update_remote_sync</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a>
</dt>
<dd></dd>
<dt>
<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef-struct" title="struct FlatpakInstalledRef">FlatpakInstalledRef</a>, struct in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a>
</dt>
<dd></dd>

View File

@@ -15,7 +15,7 @@
<div>
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Flatpak Library Reference Manual</p></th></tr></table></div>
<div><p class="releaseinfo">
For flatpak 0.6.7
For flatpak 0.6.13
</p></div>
</div>