Merge pull request #1325 from freakboy3742/appimage-docs

Document WebKit limitation on AppImage.
beeware · Jun 19, 2023 · 72f830b · 72f830b
2 parents 239f30c + 96a8dc8
commit 72f830b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/changes/1322.doc.rst b/changes/1322.doc.rst
@@ -0,0 +1 @@
+The limitations of using WebKit2 in AppImage were documented.
diff --git a/docs/reference/platforms/linux/appimage.rst b/docs/reference/platforms/linux/appimage.rst
@@ -188,6 +188,19 @@ Briefcase will unpack the new support package without cleaning up existing
 support package content. This *should* work; however, ensure a reproducible
 release artefacts, it is advisable to perform a clean app build before release.
 
+Apps using WebKit2 are not supported
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+WebKit2, the library that provides web widget support, can't currently be deployed with
+AppImage. WebKit2 uses subprocesses to manage network and rendering requests, but the
+way it packages and launches these subprocesses isn't currently compatible with
+AppImage.
+
+In addition, many of the commonly used ``manylinux`` base images predate the release of
+WebKit2. As a result, system packages providing WebKit2 are not available on these base
+images. ``manylinux_2_28`` is the earliest supported ``manylinux`` image that provides
+WebKit2 support.
+
 Runtime issues with AppImages
 =============================