Skip to content

building-introduction: Mention flatpaked flatpak-builder and app store processes #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbhtt merged 2 commits into from
Feb 12, 2025
Merged

building-introduction: Mention flatpaked flatpak-builder and app store processes #565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b18de64
building-introduction: Mention flatpaked flatpak-builder and app store
bbhtt Feb 12, 2025
798d3c2
Update po files
bbhtt Feb 12, 2025
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
10 changes: 10 additions & 0 deletions docs/building-introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
applications get built with Flatpak. This page provides an additional general
overview of what's involved.

.. note::

App stores like `Flathub <https://docs.flathub.org/docs/for-app-authors/submission>`_
has additional requirements on the building process. Please refer to
Copy link
Contributor

@hfiguiere hfiguiere Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
has additional requirements on the building process. Please refer to
have additional requirements on the building process. Please refer to

their respective documentation for details.

flatpak-builder
---------------

Expand All @@ -13,6 +19,10 @@
Flatpak application. It also allows multiple other dependencies to be built
at the same time, which get bundled into the build.

It is packaged by several distributions and there is a

Check failure on line 22 in docs/building-introduction.rst

View workflow job for this annotation

GitHub Actions / Linkcheck 

https://flathub.org/apps/org.flatpak.Builder: 404 Client Error: Not Found for url: https://flathub.org/apps/org.flatpak.Builder
Copy link
Contributor

@hfiguiere hfiguiere Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It is packaged by several distributions and there is a
It is packaged by several distributions and there is also a

`Flatpak package <https://flathub.org/apps/org.flatpak.Builder>`_ called
Copy link
Contributor

@hfiguiere hfiguiere Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sadly there is no page on flathub for it, so we should find a different way to reference it. Like linking to the flathub doc where we give the install command.

Copy link
Collaborator Author

@bbhtt bbhtt Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a metainfo, the page will be up in a few hours.

``org.flatpak.Builder`` available for it too on Flathub.
Copy link
Contributor

@hfiguiere hfiguiere Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
``org.flatpak.Builder`` available for it too on Flathub.
``org.flatpak.Builder`` available for it on Flathub.


The input to ``flatpak-builder`` is a manifest file. This specifies the
parameters for the application that will be built, such as its name and
which runtime it will depend on. The manifest also lists all the modules
Expand Down
60 changes: 41 additions & 19 deletions po/de/LC_MESSAGES/building-introduction.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Flatpak\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-05-31 14:18-0300\n"
"POT-Creation-Date: 2025-02-12 09:12+0530\n"
"PO-Revision-Date: 2019-06-26 05:15-0400\n"
"Last-Translator: Markus Richter <[email protected]>\n"
"Language: de\n"
Expand All @@ -17,7 +17,7 @@ msgstr ""
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.12.1\n"
"Generated-By: Babel 2.17.0\n"

#: ../../building-introduction.rst:2
msgid "Building Introduction"
Expand All @@ -33,11 +33,18 @@ msgstr ""
"Demonstration, wie man Anwendungen mit Flatpak erzeugt. Diese Seite "
"bietet zusätzlich eine allgemeine Übersicht, was hierbei involviert ist."

#: ../../building-introduction.rst:9
#: ../../building-introduction.rst:10
msgid ""
"App stores like `Flathub <https://docs.flathub.org/docs/for-app-"
"authors/submission>`_ has additional requirements on the building "
"process. Please refer to their respective documentation for details."
msgstr ""

#: ../../building-introduction.rst:15
msgid "flatpak-builder"
msgstr "flatpak-builder"

#: ../../building-introduction.rst:11
#: ../../building-introduction.rst:17
msgid ""
"``flatpak-builder`` is the primary tool for building Flatpak "
"applications. It allows you to take the source files for an application "
Expand All @@ -51,7 +58,14 @@ msgstr ""
"verschiedene weitere Abhängigkeiten parallel dazu aufzulösen, diese "
"werden dann in dem erzeugten Build gebündelt."

#: ../../building-introduction.rst:16
#: ../../building-introduction.rst:22
msgid ""
"It is packaged by several distributions and there is a `Flatpak package "
"<https://flathub.org/apps/org.flatpak.Builder>`_ called "
"``org.flatpak.Builder`` available for it too on Flathub."
msgstr ""

#: ../../building-introduction.rst:26
msgid ""
"The input to ``flatpak-builder`` is a manifest file. This specifies the "
"parameters for the application that will be built, such as its name and "
Expand All @@ -71,13 +85,13 @@ msgstr ""
"Eines der Module (gewöhnlich das Letzte) ist der Programmcode der "
"Anwendung selbst."

#: ../../building-introduction.rst:24
#: ../../building-introduction.rst:34
msgid "The basic format used to invoke ``flatpak-builder`` is::"
msgstr ""
"Das zugrundeliegende Format für den Aufruf von ``flatpak-builder`` sieht "
"so aus::"

#: ../../building-introduction.rst:28
#: ../../building-introduction.rst:38
msgid ""
"Where ``<build-dir>`` is the path to the directory that the application "
"will be built into, and ``<manifest>`` is the path to a manifest file. "
Expand All @@ -89,48 +103,48 @@ msgstr ""
"Der Inhalt von ``<build-dir>`` kann zum Testen und Debuggen nützlich "
"sein, wird aber generell als Artefakt des Build-Prozesses behandelt."

#: ../../building-introduction.rst:33
#: ../../building-introduction.rst:43
msgid "When ``flatpak-builder`` is run:"
msgstr "Das Ausführen von ``flatpak-builder`` setzt folgende Prozesse in Gang::"

#: ../../building-introduction.rst:35
#: ../../building-introduction.rst:45
msgid "The build directory is created, if it doesn't already exist"
msgstr "Das Build-Verzeichnis wird erzeugt, sofern es noch nicht existiert."

#: ../../building-introduction.rst:36
#: ../../building-introduction.rst:46
msgid "The source code for each module is downloaded and verified"
msgstr "Der Quellcode wird für jedes Modul heruntergeladen und verifiziert."

#: ../../building-introduction.rst:37
#: ../../building-introduction.rst:47
msgid "The source code for each module is built and installed"
msgstr "Der Quellcode wird für jedes Modul kompiliert und installiert."

#: ../../building-introduction.rst:38
#: ../../building-introduction.rst:48
#, fuzzy
msgid "The build is finished by setting sandbox permissions"
msgstr ""
"Der Erstellungsvorgang wird mit dem Setzen der Sandbox-Berechtigungen "
"abgeschlossen."

#: ../../building-introduction.rst:39
#: ../../building-introduction.rst:49
msgid ""
"The build result is exported to a repository (which will be created if it"
" doesn't exist already)"
msgstr ""
"Das Resultat des Erstellungsprozesses wird zu einem Repository exportiert"
" (welches erzeugt wird, wenn es nicht bereits existiert)."

#: ../../building-introduction.rst:42
#: ../../building-introduction.rst:52
msgid "The application can then be installed from the repository and run."
msgstr ""
"Die Anwendung kann vom Repository aus installiert und anschließend "
"gestartet werden."

#: ../../building-introduction.rst:45
#: ../../building-introduction.rst:55
msgid "Software Development Kits (SDKs)"
msgstr "Software Development Kits (SDKs)"

#: ../../building-introduction.rst:47
#: ../../building-introduction.rst:57
msgid ""
"Instead of being built using the host environment, Flatpak applications "
"are built inside a separate environment, called an SDK."
Expand All @@ -139,7 +153,7 @@ msgstr ""
"dessen werden Flatpak-Anwendungen innerhalb einer separaten Umgebung "
"erzeugt, dem SDK."

#: ../../building-introduction.rst:50
#: ../../building-introduction.rst:60
msgid ""
"SDKs are like the regular runtime that applications run in. The "
"difference is that SDKs also include all the development resources and "
Expand All @@ -152,7 +166,7 @@ msgstr ""
"zu erzeugen, sowie Tools für die Erstellung und Paketierung, Header-"
"Dateien, Compiler und Debugger."

#: ../../building-introduction.rst:55
#: ../../building-introduction.rst:65
#, fuzzy
msgid ""
"Each runtime has an accompanying SDK. For example, there is both a GNOME "
Expand All @@ -164,7 +178,7 @@ msgstr ""
"3.26 SDK. Anwendungen, die diese Laufzeitumgebung verwenden, werden mit "
"dem zugehörigen SDK erstellt."

#: ../../building-introduction.rst:59
#: ../../building-introduction.rst:69
#, fuzzy
msgid ""
"Like runtimes, SDKs will sometimes be automatically installed for you, "
Expand All @@ -176,3 +190,11 @@ msgstr ""
"werden sie auf die gleiche Weise installiert wie Anwendungen und "
"Laufzeitumgebungen. So wie hier::"

#~ msgid ""
#~ "It is packaged by several distributions"
#~ " and there is a Flatpak package "
#~ "called ``org.flatpak.Builder`` available for "
#~ "it too on `Flathub "
#~ "<https://flathub.org/apps/org.flatpak.Builder>`_."
#~ msgstr ""

60 changes: 41 additions & 19 deletions po/es/LC_MESSAGES/building-introduction.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Flatpak\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-05-31 14:18-0300\n"
"POT-Creation-Date: 2025-02-12 09:12+0530\n"
"PO-Revision-Date: 2018-05-20 10:37-0400\n"
"Last-Translator: Copied by Zanata <[email protected]>\n"
"Language: es\n"
Expand All @@ -17,7 +17,7 @@ msgstr ""
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.12.1\n"
"Generated-By: Babel 2.17.0\n"

#: ../../building-introduction.rst:2
msgid "Building Introduction"
Expand All @@ -30,11 +30,18 @@ msgid ""
"general overview of what's involved."
msgstr ""

#: ../../building-introduction.rst:9
#: ../../building-introduction.rst:10
msgid ""
"App stores like `Flathub <https://docs.flathub.org/docs/for-app-"
"authors/submission>`_ has additional requirements on the building "
"process. Please refer to their respective documentation for details."
msgstr ""

#: ../../building-introduction.rst:15
msgid "flatpak-builder"
msgstr ""

#: ../../building-introduction.rst:11
#: ../../building-introduction.rst:17
msgid ""
"``flatpak-builder`` is the primary tool for building Flatpak "
"applications. It allows you to take the source files for an application "
Expand All @@ -43,7 +50,14 @@ msgid ""
"build."
msgstr ""

#: ../../building-introduction.rst:16
#: ../../building-introduction.rst:22
msgid ""
"It is packaged by several distributions and there is a `Flatpak package "
"<https://flathub.org/apps/org.flatpak.Builder>`_ called "
"``org.flatpak.Builder`` available for it too on Flathub."
msgstr ""

#: ../../building-introduction.rst:26
msgid ""
"The input to ``flatpak-builder`` is a manifest file. This specifies the "
"parameters for the application that will be built, such as its name and "
Expand All @@ -54,74 +68,74 @@ msgid ""
"application code itself."
msgstr ""

#: ../../building-introduction.rst:24
#: ../../building-introduction.rst:34
msgid "The basic format used to invoke ``flatpak-builder`` is::"
msgstr ""

#: ../../building-introduction.rst:28
#: ../../building-introduction.rst:38
msgid ""
"Where ``<build-dir>`` is the path to the directory that the application "
"will be built into, and ``<manifest>`` is the path to a manifest file. "
"The contents of ``<build-dir>`` can be useful for testing and debugging "
"purposes, but is generally treated as an artifact of the build process."
msgstr ""

#: ../../building-introduction.rst:33
#: ../../building-introduction.rst:43
msgid "When ``flatpak-builder`` is run:"
msgstr ""

#: ../../building-introduction.rst:35
#: ../../building-introduction.rst:45
msgid "The build directory is created, if it doesn't already exist"
msgstr ""

#: ../../building-introduction.rst:36
#: ../../building-introduction.rst:46
msgid "The source code for each module is downloaded and verified"
msgstr ""

#: ../../building-introduction.rst:37
#: ../../building-introduction.rst:47
msgid "The source code for each module is built and installed"
msgstr ""

#: ../../building-introduction.rst:38
#: ../../building-introduction.rst:48
msgid "The build is finished by setting sandbox permissions"
msgstr ""

#: ../../building-introduction.rst:39
#: ../../building-introduction.rst:49
msgid ""
"The build result is exported to a repository (which will be created if it"
" doesn't exist already)"
msgstr ""

#: ../../building-introduction.rst:42
#: ../../building-introduction.rst:52
msgid "The application can then be installed from the repository and run."
msgstr ""

#: ../../building-introduction.rst:45
#: ../../building-introduction.rst:55
msgid "Software Development Kits (SDKs)"
msgstr ""

#: ../../building-introduction.rst:47
#: ../../building-introduction.rst:57
msgid ""
"Instead of being built using the host environment, Flatpak applications "
"are built inside a separate environment, called an SDK."
msgstr ""

#: ../../building-introduction.rst:50
#: ../../building-introduction.rst:60
msgid ""
"SDKs are like the regular runtime that applications run in. The "
"difference is that SDKs also include all the development resources and "
"tools that are required to build an application, such as build and "
"packaging tools, header files, compilers and debuggers."
msgstr ""

#: ../../building-introduction.rst:55
#: ../../building-introduction.rst:65
msgid ""
"Each runtime has an accompanying SDK. For example, there is both a GNOME "
"43 runtime and a GNOME 43 SDK. Applications that use the runtime are "
"built with the matching SDK."
msgstr ""

#: ../../building-introduction.rst:59
#: ../../building-introduction.rst:69
msgid ""
"Like runtimes, SDKs will sometimes be automatically installed for you, "
"but if you do need to manually install them, they are installed in the "
Expand Down Expand Up @@ -149,3 +163,11 @@ msgstr ""
#~ "SDK."
#~ msgstr ""

#~ msgid ""
#~ "It is packaged by several distributions"
#~ " and there is a Flatpak package "
#~ "called ``org.flatpak.Builder`` available for "
#~ "it too on `Flathub "
#~ "<https://flathub.org/apps/org.flatpak.Builder>`_."
#~ msgstr ""

Loading
Loading