Skip to content

Commit

Permalink
Add documentation for various module source types
Browse files Browse the repository at this point in the history
Reference the new docs where possible
  • Loading branch information
bbhtt committed May 28, 2024
1 parent 4e8eb50 commit e1efeca
Show file tree
Hide file tree
Showing 4 changed files with 576 additions and 21 deletions.
1 change: 1 addition & 0 deletions docs/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ before reading this section.
dependencies
flatpak-builder
manifests
module-sources
sandbox-permissions
guides
20 changes: 0 additions & 20 deletions docs/conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,26 +179,6 @@ The distribution usually appends those paths to ``$XDG_DATA_DIRS`` on
host when installing the ``flatpak`` package. Unless a desktop file is
exported by Flatpak, host applications cannot access it.

Exporting through extra-data
----------------------------

.. note::

Note, that when creating a Flatpak package for a software store like
Flathub or when composing the metadata with appstreamcli, desktop files
and icons must not be placed in ``/app/extra/export/`` and instead
should go to the proper locations documented above.

Files downloaded through ``extra-data`` are only downloaded when installing, as such they aren't yet available for ``flatpak-builder`` to automatically export during the build process.

When using ``extra-data``, place any files that must be exported under this location::

/app/extra/export/share/

For example, if GNOME Dictionary used ``extra-data`` to download a 96x96 icon this would be its path::

/app/extra/export/share/icons/hicolor/96x96/apps/org.gnome.Dictionary.png

Technical conventions
---------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/manifests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ types include:
include archive or package files

Different properties are available for each source type, which are listed
in the :doc:`flatpak-builder-command-reference`.
in the :doc:`module-sources`.

Supported build systems
```````````````````````
Expand Down
Loading

0 comments on commit e1efeca

Please sign in to comment.