Document stub binary configuration options and command line arguments.

beeware · May 30, 2024 · 17c301f · 17c301f
1 parent b7587b2
commit 17c301f
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 3 deletions.
diff --git a/docs/reference/commands/build.rst b/docs/reference/commands/build.rst
@@ -75,7 +75,7 @@ running:
     $ briefcase build
 
 ``--update-support``
-----------------------
+--------------------
 
 Update application support package before building. Equivalent to running:
 
@@ -84,6 +84,16 @@ Update application support package before building. Equivalent to running:
     $ briefcase update --update-resources
     $ briefcase build
 
+``--update-stub``
+-----------------
+
+Update stub binary before building. Equivalent to running:
+
+.. code-block:: console
+
+    $ briefcase update --update-stub
+    $ briefcase build
+
 ``--test``
 ----------
 

diff --git a/docs/reference/commands/run.rst b/docs/reference/commands/run.rst
@@ -102,7 +102,7 @@ running:
     $ briefcase run
 
 ``--update-support``
-----------------------
+--------------------
 
 Update application support package before running. Equivalent to running:
 
@@ -112,6 +112,17 @@ Update application support package before running. Equivalent to running:
     $ briefcase build
     $ briefcase run
 
+``--update-stub``
+-----------------
+
+Update stub binary before running. Equivalent to running:
+
+.. code-block:: console
+
+    $ briefcase update --update-stub
+    $ briefcase build
+    $ briefcase run
+
 ``--test``
 ----------
 

diff --git a/docs/reference/commands/update.rst b/docs/reference/commands/update.rst
@@ -47,6 +47,11 @@ Update application requirements.
 Update application resources such as icons.
 
 ``--update-support``
-----------------------
+--------------------
 
 Update application support package.
+
+``--update-stub``
+-----------------
+
+Update stub binary.
diff --git a/docs/reference/configuration.rst b/docs/reference/configuration.rst
@@ -378,6 +378,26 @@ color for splash screens.
 If the platform output format does not use a splash screen, this setting is
 ignored.
 
+``stub_binary``
+~~~~~~~~~~~~~~~
+
+A file path or URL pointing at a pre-compiled binary (or a zip/tarball of a binary) that
+can be used as an entry point for a bundled application.
+
+If this setting is not provided, and a stub binary is required by the platform,
+Briefcase will use the default stub binary for the platform.
+
+``stub_binary_revision``
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The specific revision of the stub binary that should be used. By default, Briefcase will
+use the stub binary revision nominated by the application template. If you specify a
+stub binary revision, that will override the revision nominated by the application
+template.
+
+If you specify an explicit stub binary (using the ``stub_binary`` setting), this
+argument is ignored.
+
 ``support_package``
 ~~~~~~~~~~~~~~~~~~~