summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Leeds <matthew.leeds@endlessm.com>2018-07-10 17:53:01 +0200
committerAlexander Larsson <alexander.larsson@gmail.com>2018-07-10 19:26:06 +0200
commitc9a9b3a1ee7a63490adc00c51ff8e1c9777fa055 (patch)
treeaccd85f546216695fcdb8deccb217689ab4e5d23
parent9c4072573948caca19108db13314e6442d89ce4c (diff)
downloadflatpak-c9a9b3a1ee7a63490adc00c51ff8e1c9777fa055.tar.gz
doc: Mention P2P capabilities of install/update
Fixes https://github.com/flatpak/flatpak/issues/1329
-rw-r--r--doc/flatpak-install.xml7
-rw-r--r--doc/flatpak-update.xml7
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/flatpak-install.xml b/doc/flatpak-install.xml
index adeb0776..b8f0fb27 100644
--- a/doc/flatpak-install.xml
+++ b/doc/flatpak-install.xml
@@ -80,6 +80,13 @@
will be created for the lifetime of the <arg choice="plain">REF</arg>.
</para>
<para>
+ If the specified <arg choice="plain">REMOTE</arg> has a collection ID configured on it,
+ flatpak will search mounted filesystems such as USB drives as well as Avahi services
+ advertised on the local network for the needed refs, in order to support to support
+ offline updates. See <citerefentry><refentrytitle>ostree-find-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ for more information.
+ </para>
+ <para>
The alternative form of the command (<arg>--from</arg> or
<arg>--bundle</arg> allows you to
install directly from a source such as a .flatpak
diff --git a/doc/flatpak-update.xml b/doc/flatpak-update.xml
index 7142e679..c4a69514 100644
--- a/doc/flatpak-update.xml
+++ b/doc/flatpak-update.xml
@@ -69,6 +69,13 @@
with the --commit option.
</para>
<para>
+ If the configured remote for a ref being updated has a collection ID configured on it,
+ flatpak will search mounted filesystems such as USB drives as well as Avahi services
+ advertised on the local network for the needed refs, in order to support to support
+ offline updates. See <citerefentry><refentrytitle>ostree-find-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ for more information.
+ </para>
+ <para>
Note that updating a runtime is different from installing
a different branch, and runtime updates are expected to keep
strict compatibility. If an application update does cause