Skip to content

Commit 8202c48

Browse files
committed
conventions: Add appstream command used to compose metadata
1 parent 5aaad85 commit 8202c48

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/conventions.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,21 @@ The distribution usually appends those paths to ``$XDG_DATA_DIRS`` on
178178
the host when installing the ``flatpak`` package. Unless a desktop file is
179179
exported by Flatpak, host applications cannot access it.
180180

181+
182+
The metainfo file along with the other metadata such as icon and desktop
183+
files is composed into a catalogue by ``appstream``. Since 1.3.4,
184+
Flatpak Builder by default uses ``appstreamcli`` from `libappstream <https://github.com/ximion/appstream/>`_
185+
to compose this and executes the following command::
186+
187+
$ appstreamcli compose --no-partial-urls --prefix=/ --origin=${FLATPAK_ID} --media-baseurl=<repo-media-url> --media-dir=${FLATPAK_DEST}/share/app-info/media --result-root=${FLATPAK_DEST} --data-dir=${FLATPAK_DEST}/share/app-info/xmls --icons-dir=${FLATPAK_DEST}/share/app-info/icons/flatpak --components=${FLATPAK_ID} ${FLATPAK_DEST}
188+
189+
190+
``${FLATPAK_ID}`` is the Flatpak application ID and ``${FLATPAK_DEST}``
191+
is set to ``/app`` for apps and ``/usr`` for runtimes. The ``media-baseurl``
192+
controls the base URL used for mirroring screenshots. Usually each app
193+
store will have their own base URL for this. On Flathub this is
194+
set to ``https://dl.flathub.org/media/``.
195+
181196
Technical conventions
182197
---------------------
183198

0 commit comments

Comments
 (0)