Skip to content

Commit

Permalink
Tweak some wording and add more information on source directories
Browse files Browse the repository at this point in the history
  • Loading branch information
bbhtt committed May 25, 2024
1 parent 455b032 commit 82eacb9
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/module-sources.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
Module Sources
==============

A list of available module sources can be found in :doc:`manifests`. This
guide will go in depth on each of them and provide examples.
This page will go in depth on each source type with examples.

Sources are copied or downloaded to the source directory before the build
starts.
starts. The source directory lives under flatpak-builder's state
directory, which by default is located at ``.flatpak-builder`` on host,
relative to the manifest root. The source directory for bzr, git and svn
sources is at ``.flatpak-builder/git, .flatpak-builder/bzr, .flatpak-builder/svn``
respectively while ``.flatpak-builder/downloads/<checksum>`` is used
for file and archive sources.

The ``type`` property of a source determines how that source will be
handled before or during build by ``flatpak`` or ``flatpak-builder``.
Expand All @@ -14,8 +18,8 @@ Most of the sources support ``path`` and ``url`` property where ``path``
is relative to the root of manifest and ``url`` is a direct url to the
source.

The ``url`` property requires a ``checksum`` of the file to be specified
after it using ``sha256`` or ``sha512``.
The ``url`` property requires a checksum to be specified after
using ``sha256`` or ``sha512``.

There are a few properties common to all source types ``only-arches``,
``skip-arches`` and ``dest``.
Expand Down Expand Up @@ -79,8 +83,6 @@ These are sources of ``type: archive``. They are downloaded to the
download directory and extracted into the build directory when the build
starts.

The download directoy is ``.flatpak-builder/downloads/<checksum of source>/``.

A typical example of using this is:

.. code-block:: yaml
Expand Down

0 comments on commit 82eacb9

Please sign in to comment.