Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/available-runtimes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ based on the Freedesktop runtime and adds the libraries and components
used by the GNOME platform.

Major version releases of the runtime are synced with `GNOME releases <https://release.gnome.org/calendar/>`_
and are announced on `GNOME Discourse <https://discourse.gnome.org/tag/announcement>`_.
and are announced on `GNOME Discourse <https://discourse.gnome.org/tag/announcement/44>`_.
Usually a given branch of the runtime is supported for a year and EOL-ed
upon the release of a newstable version.

Expand Down
14 changes: 13 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
linkcheck_anchors_ignore_for_url = [
r'https://github\.com/.*',
r'https://gitlab\.com/.*',
r'https://hg\.mozilla\.org/.*',
r'https://hg-edge\.mozilla\.org/.*',
r'https://gitlab\.gnome\.org/GNOME/Initiatives/-/wikis/DevOps-with-Flatpak'
]

Expand All @@ -174,6 +174,18 @@
}
}

linkcheck_allowed_redirects = {
# Locale redirects
r"https://flathub\.org/?":
r"https://flathub\.org/en/?",

r"https://flathub\.org/apps/.*":
r"https://flathub\.org/en/apps/.*",

r"https://flatpak\.org/setup":
r"https://flathub\.org(/en)?/setup/?",
}

linkcheck_retries = 2
linkcheck_timeout = 10

Expand Down
10 changes: 5 additions & 5 deletions docs/conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Developers must follow the standard `D-Bus naming conventions for bus names
<https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names>`_
when creating their own IDs. This format is
already recommended by the `Desktop File specification
<https://specifications.freedesktop.org/desktop-entry-spec/latest/file-naming.html>`_
<https://specifications.freedesktop.org/desktop-entry/latest/file-naming.html>`_
and also the `Appstream specification
<https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#sect-Metadata-GenericComponent>`_.

Expand Down Expand Up @@ -119,7 +119,7 @@ Application icons
Applications are expected to provide an application icon, which
is used for their application launcher. These icons should be
provided in accordance with the `Freedesktop icon specification
<https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html>`_.
<https://specifications.freedesktop.org/icon-theme/icon-theme-spec-latest.html>`_.

Icons must be named using the application's ID, be in either PNG or SVG
format, and must be placed in the standard location::
Expand Down Expand Up @@ -152,7 +152,7 @@ Desktop files

Desktop files are used to provide the desktop environment with
information about each application. The `Freedesktop specification
<https://specifications.freedesktop.org/desktop-entry-spec/latest/>`_
<https://specifications.freedesktop.org/desktop-entry/latest/>`_
provides a complete reference for writing desktop files.

Desktop files must be named using the application's ID, followed
Expand Down Expand Up @@ -296,7 +296,7 @@ is provided below::
- the "fdo #xxxxx" are the wish in the freedesktop.org bug database to include
the mime type there.
-->
<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info">
<mime-info xmlns="https://specifications.freedesktop.org/shared-mime-info/">
<mime-type type="application/x-vnd.akonadi.calendar.event">
<sub-class-of type="text/calendar"/>
<comment>iCal Calendar Event Component</comment>
Expand Down Expand Up @@ -357,7 +357,7 @@ XDG base directories
--------------------

`XDG base directories
<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_ are
<https://specifications.freedesktop.org/basedir/basedir-spec-latest.html>`_ are
standard locations for user-specific application data. Popular toolkits provide
convenience functions for accessing XDG base directories. These include:

Expand Down
2 changes: 1 addition & 1 deletion docs/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Getting stacktraces from a crash
--------------------------------

If an application crashed and the system has coredumps and
`systemd-coredump <https://www.freedesktop.org/software/systemd/man/latest/systemd-coredump.html#>`_
`systemd-coredump <https://www.freedesktop.org/software/systemd/man/latest/systemd-coredump.html>`_
enabled, a coredump will be logged. Get the ``PID`` from that coredump::

$ coredumpctl list
Expand Down
8 changes: 4 additions & 4 deletions docs/electron.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ from other applications. It also includes information on the tooling for
building Electron applications and how to use it.

The guide walks through the `manifest file
<https://github.com/flathub/electron-sample-app/blob/master/org.flathub.electron-sample-app.yml>`_
<https://github.com/flathub/org.flathub.electron-sample-app/blob/master/org.flathub.electron-sample-app.yml>`_
of the `sample Electron Flatpak application
<https://github.com/flathub/electron-sample-app>`_. Before you start,
<https://github.com/flathub/org.flathub.electron-sample-app>`_. Before you start,
it is a good idea to take a look at this, either online or by downloading
the application.

Expand Down Expand Up @@ -228,7 +228,7 @@ and hash of the application are also specified.
subdir: main
sources:
- type: archive
url: https://github.com/flathub/electron-sample-app/archive/1.0.1.tar.gz
url: https://github.com/flathub/org.flathub.electron-sample-app/archive/1.0.1.tar.gz
sha256: a2feb3f1cf002a2e4e8900f718cc5c54db4ad174e48bfcfbddcd588c7b716d5b
dest: main

Expand Down Expand Up @@ -320,6 +320,6 @@ The preferred way of fixing this, is not a patch, but a build-time edit using ``
Make setProgressBar and setBadgeCount work
-------------------------------------------
The `setProgressBar <https://www.electronjs.org/docs/latest/api/browser-window#winsetprogressbarprogress-options>`_ and `setBadgeCount <https://www.electronjs.org/docs/latest/api/app#appsetbadgecountcount-linux-macos>`_ functions allow showing a progress bar and a badge count in the window icon. It is implemented under Linux using the `UnityLauncherAPI <https://wiki.ubuntu.com/Unity/LauncherAPI>`_. This API is not implemented on every desktop environment. A known desktop environment which implements this is KDE.
It is also implemented by the popular `Dash to Dock <https://micheleg.github.io/dash-to-dock>`_ GNOME extension and `Plank <https://launchpad.net/plank>`_.
It is also implemented by the popular `Dash to Dock <https://micheleg.github.io/dash-to-dock/>`_ GNOME extension and `Plank <https://launchpad.net/plank>`_.

To make it work in Flatpak, the app needs to :ref:`use the correct desktop filename <use-correct-desktop-filename>` in its embedded `package.json` file. The Flatpak also needs the ``--talk-name=com.canonical.Unity`` permission. Electron versions earlier than v32 checks `checks if it's running on Unity or KDE <https://github.com/electron/electron/blob/fb88375ab4d2161dbf7e958a2a94c7c6d97dc84c/shell/browser/linux/unity_service.cc#L64>`_ before using the UnityLauncherAPI.
8 changes: 4 additions & 4 deletions docs/extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ extension points.

An example of an extension point defined in runtime is the GL extension
point used in `Freedesktop SDK <https://gitlab.com/freedesktop-sdk/freedesktop-sdk/-/blob/1a8039407f8573725b16eab8779f2b0e1cd01629/elements/flatpak-images/platform.bst>`_
Freedesktop SDK uses `buildstream <https://buildstream.build/index.html>`_,
Freedesktop SDK uses `buildstream <https://buildstream.apache.org/index.html>`_,
so the `format <https://docs.buildstream.build/master/format_project.html>`_
is different from the usual ``json`` or ``yaml`` format used by Flatpak
manifests.
Expand Down Expand Up @@ -456,7 +456,7 @@ stores. This is a typical example of an extension MetaInfo file.
<developer id="com.example">
<name>Bar</name>
</developer>
<url type="homepage">https://flatpak.github.io/</url>
<url type="homepage">https://flatpak.org/</url>
<update_contact>bar_AT_example.org</update_contact>
<releases>
<release version="1.2.0" date="2023-12-03">
Expand Down Expand Up @@ -518,7 +518,7 @@ the same as above.

An example of an unmaintained extension can be found in browsers such as
`Chromium <https://github.com/flathub/org.chromium.Chromium/blob/dc7f731e7b62199a00bfa3ea3d123ff6d16936dc/org.chromium.Chromium.yaml>`_
or `Firefox <https://hg.mozilla.org/mozilla-central/diff/59e57f57dcb73a286822276d02f16e7b17018de6/taskcluster/docker/firefox-flatpak/runme.sh>`_
or `Firefox <https://hg-edge.mozilla.org/mozilla-central/diff/59e57f57dcb73a286822276d02f16e7b17018de6/taskcluster/docker/firefox-flatpak/runme.sh>`_
on Flathub.

The Firefox snippet translates to:
Expand All @@ -538,7 +538,7 @@ and ``/var/lib/flatpak/extension/org.mozilla.firefox.systemconfig/x86_64/stable/
(or in ``$XDG_DATA_HOME/flatpak/extension/...``) respectively on host.
The path here is dependent on the extension point. These would appear
under ``/app/etc/firefox/policies/policies.json`` and
``/app/etc/firefox/defaults/pref`` inside the sandbox. (Firefox `supports <https://hg.mozilla.org/mozilla-central/file/23ee4ac2d048de0aac3fa27ce7eb0925c1903096/xpcom/io/SpecialSystemDirectory.cpp#l198>`_
``/app/etc/firefox/defaults/pref`` inside the sandbox. (Firefox `supports <https://hg-edge.mozilla.org/mozilla-central/file/23ee4ac2d048de0aac3fa27ce7eb0925c1903096/xpcom/io/SpecialSystemDirectory.cpp#l198>`_
reading policies from ``/app/etc``)

For details on Chromium, please look at the
Expand Down
2 changes: 1 addition & 1 deletion docs/first-build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ See :doc:`single-file-bundles` for more details on it.

.. code-block:: bash

flatpak build-bundle repo hello.flatpak org.flatpak.Hello --runtime-repo=https://flathub.org/repo/flathub.flatpakrepo
flatpak build-bundle repo hello.flatpak org.flatpak.Hello --runtime-repo=https://dl.flathub.org/repo/flathub.flatpakrepo

Now you can send the ``hello.flatpak`` file to someone and if they have
the Flathub repository set up and a working network connection to install
Expand Down
2 changes: 1 addition & 1 deletion docs/flatpak-devel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ desktop file to fix the window class.
Additional tools
----------------

- `Electron Builder <https://www.electron.build/flatpak.html>`_
- `Electron Builder <https://www.electron.build/flatpak/>`_
supports exporting single file Flatpak bundles. Please also see the
Electron application packaging guide :doc:`electron`.

Expand Down
Loading
Loading