Skip to content
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

Jump to bottom

Add troubleshooting section for building #413

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add troubleshooting section for building #413

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/building.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ before reading this section.
manifests
sandbox-permissions
guides
troubleshooting
16 changes: 16 additions & 0 deletions docs/troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Troubleshooting
===============

Sometimes you run into issues when building Flatpaks. This page includes a list
of common problems and how to solve them.

Remote server doesn't support shallow cloning
---------------------------------------------

If you get an error message like
``fatal: dumb http transport does not support shallow capabilities`` when
building your Flatpak application, it's because ``flatpak-builder`` will by
default attempt to shallow clone git repositories as an optimisation. However,
not all git remotes support shallow cloning, and in such cases you can disable
this optimisation by setting the ``disable-shallow-clone`` property to ``true``
in your source.