Skip to content

Enhance debugging instructions in documentation #611

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

Closed
bmp192529 wants to merge 1 commit into from
Closed

Enhance debugging instructions in documentation #611

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/debugging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ This section includes documentation on how to debug Flatpak apps.
Debug packages
--------------

Before debugging, it is essential to install the debug packages used by
Before debugging, ensure you fully install the package, as simply running the package with "flatpak-builder --run ..." will run a version of the program with more limited system integration. Many perceived bugs seen when running the application with "flatpak-builder --run" may completely disapear when the application is installed fully. Some examples of features that might not work properly while running within flatpak-builder are file explorer dialogues and automatic detection of Wayland or X11 sessions. To make a local test install of your application, and then run it, use the following::

$ flatpak-builder --install <build-dir> <manifest>
Copy link
Collaborator

@razzeee razzeee Dec 1, 2025

Choose a reason for hiding this comment

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

Use flatpak-builder from inside flatpak, as we suggests in the docs. (this only won't work for extra data apps)

Copy link
Author

@bmp192529 bmp192529 Dec 1, 2025

Choose a reason for hiding this comment

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

I'm not sure what you mean by "from inside flatpak". Can you explain and potentially point out where the docs suggest this?

Copy link
Collaborator

@razzeee razzeee Dec 1, 2025

Choose a reason for hiding this comment

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

https://docs.flathub.org/docs/for-app-authors/submission#build-and-install

flatpak run --command=flathub-build org.flatpak.Builder --install <manifest>

Copy link
Author

@bmp192529 bmp192529 Dec 1, 2025

Choose a reason for hiding this comment

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

Ok, thank you for clarifying that. It seems that you are talking about the flatHub documentation, while I was referring to the flatpak and flatpak-builder documentation. If you review the building section of the flatpak documentation at https://docs.flatpak.org/en/latest/building.html, you'll see that the command you specify is not used in any of the pages in that section.

As a related point, what is the intended function of "flatpak-builder --run" if running a program in that manner is not recommended?

Copy link
Collaborator

@razzeee razzeee Dec 1, 2025

Choose a reason for hiding this comment

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

Sorry, I'm in the wrong context

Copy link
Collaborator

@razzeee razzeee Dec 1, 2025

Choose a reason for hiding this comment

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

Sorry, I'm in the wrong context

$ flatpak run org.example.app

To begin debugging, it is essential to install the debug packages used by
the application. This can be done by::


Expand Down
Loading