From 95ffefe8788be3c15d78815f6ec88829925caaab Mon Sep 17 00:00:00 2001 From: Stefan Hansson Date: Sun, 22 Oct 2023 15:56:49 +0200 Subject: [PATCH] Add troubleshooting section for building --- docs/building.rst | 1 + docs/troubleshooting.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 docs/troubleshooting.rst diff --git a/docs/building.rst b/docs/building.rst index 2f98b73d..c183078f 100644 --- a/docs/building.rst +++ b/docs/building.rst @@ -19,3 +19,4 @@ before reading this section. manifests sandbox-permissions guides + troubleshooting diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst new file mode 100644 index 00000000..83b9a239 --- /dev/null +++ b/docs/troubleshooting.rst @@ -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.