[Python-checkins] gh-100247: Improve documentation for custom shebang commands in py.exe launcher (GH-101083)

zooba webhook-mailer at python.org
Mon Jan 16 12:01:11 EST 2023


https://github.com/python/cpython/commit/30753c37c6d00929af6afb5e0bc20bed4656d6b6
commit: 30753c37c6d00929af6afb5e0bc20bed4656d6b6
branch: main
author: Steve Dower <steve.dower at python.org>
committer: zooba <steve.dower at microsoft.com>
date: 2023-01-16T17:01:04Z
summary:

gh-100247: Improve documentation for custom shebang commands in py.exe launcher (GH-101083)

files:
M Doc/using/windows.rst

diff --git a/Doc/using/windows.rst b/Doc/using/windows.rst
index 69bca4d7bd30..b2a0214026e4 100644
--- a/Doc/using/windows.rst
+++ b/Doc/using/windows.rst
@@ -880,14 +880,15 @@ The environment variable :envvar:`PYLAUNCHER_NO_SEARCH_PATH` may be set
 Shebang lines that do not match any of these patterns are looked up in the
 ``[commands]`` section of the launcher's :ref:`.INI file <launcher-ini>`.
 This may be used to handle certain commands in a way that makes sense for your
-system. The name of the command must be a single argument (no spaces),
-and the value substituted is the full path to the executable (no arguments
-may be added).
+system. The name of the command must be a single argument (no spaces in the
+shebang executable), and the value substituted is the full path to the
+executable (additional arguments specified in the .INI will be quoted as part
+of the filename).
 
 .. code-block:: ini
 
    [commands]
-   /bin/sh=C:\Program Files\Bash\bash.exe
+   /bin/xpython=C:\Program Files\XPython\python.exe
 
 Any commands not found in the .INI file are treated as **Windows** executable
 paths that are absolute or relative to the directory containing the script file.



More information about the Python-checkins mailing list