From ef58b499ba33ef8471eb02da67cdd815180764c0 Mon Sep 17 00:00:00 2001 From: William Lachance Date: Fri, 24 Apr 2020 15:43:22 -0400 Subject: [PATCH] Bug 1632645 - Explicitly note caveat about pyinstaller (#843) * Bug 1632645 - Explicitly note caveat about pyinstaller * Update docs/user/adding-glean-to-your-project.md Co-Authored-By: Michael Droettboom Co-authored-by: Michael Droettboom --- docs/user/adding-glean-to-your-project.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/adding-glean-to-your-project.md b/docs/user/adding-glean-to-your-project.md index 551fba932..4e752f34f 100644 --- a/docs/user/adding-glean-to-your-project.md +++ b/docs/user/adding-glean-to-your-project.md @@ -281,7 +281,7 @@ This handler will wait up to 1 second for any pending work to complete. In addition, by default ping uploading is performed in a separate child process. This process will continue to upload any pending pings even after the main process shuts down. -Since the subprocess approach may not work in all contexts, there is an option to ensure that ping uploading occurs in the main process. To do this, set the `allow_multiprocessing` parameter on the `glean.Configuration` object to `False`. +Note that this approach may not work with applications built using [`PyInstaller`](https://www.pyinstaller.org/) or similar tools which bundle an application together with a Python interpreter. For these cases (and any others which we haven't thought of), there is an option to ensure that ping uploading occurs in the main process. To do this, set the `allow_multiprocessing` parameter on the `glean.Configuration` object to `False`. {{#include ../tab_footer.md}}