Skip to content

gh-133503: Update compileall.rst's documentation of -s and -p for clarity, #134756

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

Merged
merged 6 commits into from
Jun 1, 2025
Merged

gh-133503: Update compileall.rst's documentation of -s and -p for clarity, #134756

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f2db41
gh-133503 Update `compileall.rst`'s documentation of `-s` and `-p` fo…
sharktide May 26, 2025
5e7aad9
gh-133503: Remove note attribute and document `-s` separately
sharktide May 26, 2025
30de5e7
gh-133503 Do not reference `s` too much in `p`
sharktide May 26, 2025
5442260
gh-133503: Remove any and all references of `s` and `p` together
sharktide May 27, 2025
6be87f8
gh-133503 Update compileall.rst again for clarity
sharktide May 27, 2025
812c25c
gh-133503 Fix wrong words - Append to Prepend
sharktide May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/library/compileall.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,19 @@ compile Python sources.
executed.

.. option:: -s strip_prefix

.. warning::
Removing the prefix makes paths relative to it.

.. option:: -p prepend_prefix

Remove (``-s``) or append (``-p``) the given prefix of paths
recorded in the ``.pyc`` files.
Cannot be combined with ``-d``.

``-s`` and ``-p`` can be used simultaneously.
``-p /`` can be used to make the path absolute.

.. option:: -x regex

regex is used to search the full path to each file considered for
Expand Down
Loading