summaryrefslogtreecommitdiff
path: root/doc/flatpak-remote.xml
diff options
context:
space:
mode:
authorMatthew Leeds <matthew.leeds@endlessm.com>2020-07-16 18:57:40 -0700
committerAlexander Larsson <alexander.larsson@gmail.com>2020-08-17 09:21:30 +0200
commit845a877ce1923a8d8b544984f3614ab72ad75a49 (patch)
treed9314e0b039a530bf648330a4709198e26bbb073 /doc/flatpak-remote.xml
parent676d1e0899690f8fe50ef875e9001588689eb1a5 (diff)
downloadflatpak-845a877ce1923a8d8b544984f3614ab72ad75a49.tar.gz
Prioritize an app's origin for its runtime
Currently when searching for a remote to provide the runtime for an app, we search remotes in priority order. This commit makes it so we search the remote providing the app before others with the same priority, and otherwise still search in priority order. This means for the common case where every remote has the default priority of 1, the app's origin will have the first chance to provide the runtime. This behavior seems logical, but the impetus for this change was also to keep a unit test passing in eos-updater[1] after a port to FlatpakTransaction. Originally the eos-updater unit test was written to prioritize the origin remote regardless of the priorities on any other remote, but during code review it was decided to let higher priority remotes stay above the app's origin. In practice it's usually true that only one remote provides a runtime and priorities aren't set at all, so this is an edge case that probably doesn't come up much. A unit test and documentation updates are included. [1] https://github.com/endlessm/eos-updater/blob/eede0a8b9cb7c9cbb8539cfcaad9ce18913dcdd8/tests/test-update-install-flatpaks.c#L1919
Diffstat (limited to 'doc/flatpak-remote.xml')
-rw-r--r--doc/flatpak-remote.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/flatpak-remote.xml b/doc/flatpak-remote.xml
index 1f1fb5be..4545e202 100644
--- a/doc/flatpak-remote.xml
+++ b/doc/flatpak-remote.xml
@@ -104,7 +104,9 @@
</varlistentry>
<varlistentry>
<term><option>xa.prio</option> (integer)</term>
- <listitem><para>The priority for the remote. This is used when listing remotes. Defaults to 1.</para></listitem>
+ <listitem><para>The priority for the remote. This is used when listing remotes, and when
+ searching them for the runtime needed by an app. The remote providing the app is
+ searched for its runtime before others with equal priority. Defaults to 1.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.noenumerate</option> (boolean)</term>