Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various documentation updates [skip ci] #8214

Merged
merged 3 commits into from Jan 7, 2024
Merged

Various documentation updates [skip ci] #8214

merged 3 commits into from Jan 7, 2024

Commits on Jan 7, 2024

  1. docs: update the introduction in Understanding PyInstaller Hooks 

    Update the introduction section of the Understanding PyInstaller
Hooks - change the minimal hook example from hook for `dnspython`
(`hook-dns.rdata.py`) to hook for `xml.dom.domreg.py` module from
Python standard libary.

Add URLs for browsing the hooks available in both `PyInstaller`
and `pyinstaller-hooks-contrib` repositories.
    @rokm
    rokm committed Jan 7, 2024
    Configuration menu
    Copy the full SHA
    9b58a79 View commit details
    Browse the repository at this point in the history

  2. docs: update section on macOS App Bundles under Using PyInstaller 

    Update the section on macOS app bundles under Using PyInstaller
to reflect the current layout of generated app bundles - i.e., the
MacOS directory containing only the executable, binaries being
placed in the Frameworks directory, cross-linking of content
between Frameworks and Resources, etc.

Add a note to discourage users from generating onefile .app
bundles.
    @rokm
    rokm committed Jan 7, 2024
    Configuration menu
    Copy the full SHA
    a87d201 View commit details
    Browse the repository at this point in the history

  3. docs: add a "Common Issues and Pitfalls" chapter to docs [skip ci] 

    Add a new documentation chapter, "Common Issues and Pitfalls" which
at the moment covers the following topics:

Frozen applications on macOS and Linux making use of symbolic
links since PyInstaller 6.0, and the implications for distribution
(e.g., taking care that symlinks are preserved when copying the
frozen application or creating an archive).

Launching external programs from the frozen application; provides
the explanation of why launching external applications requires
manual sanitization oflibrary search paths, and how to achieve it.
Primary goal is to document the modifications of libary-search-path
related environment variables - both by bootloader, and potentially
also by run-time hooks. But we also need to mention that on
Windows, `SetDllDirectory()` is used, and that in order to undo
its effects, `SetDllDirectory(NULL)` call is needed...

Multi-processing; document and explain the need for calling
`multiprocessing.freeze_support` when using `multiprocessing`
functionality.

Windowed/noconsole mode on Windows; explain that in noconsole
builds on Windows, standard I/O file handles are `None`, and
provide a work-around for code that naively tries to access
their attributes without first checking that they are available.
    @rokm
    rokm committed Jan 7, 2024
    Configuration menu
    Copy the full SHA
    ac6ba27 View commit details
    Browse the repository at this point in the history