From: Rihaan Meher <meherrihaan@gmail.com>
Date: Sun, 1 Jun 2025 08:18:31 +0000 (-0400)
Subject: gh-133503: clarify `compileall -s/-p` docs (#134756)
X-Git-Tag: v3.15.0a1~1425
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=fe6f8a3619242b287a793a5b5d8645f402482c71;p=thirdparty%2FPython%2Fcpython.git

gh-133503: clarify `compileall -s/-p` docs (#134756)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
---

diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index c42288419c4d..ebbbf857e717 100644
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -56,11 +56,18 @@ compile Python sources.
    executed.
 
 .. option:: -s strip_prefix
+
+   Remove the given prefix from paths recorded in the ``.pyc`` files.
+   Paths are made relative to the prefix.
+
+   This option can be used with ``-p`` but not with ``-d``.
+
 .. option:: -p prepend_prefix
 
-   Remove (``-s``) or append (``-p``) the given prefix of paths
-   recorded in the ``.pyc`` files.
-   Cannot be combined with ``-d``.
+   Prepend the given prefix to paths recorded in the ``.pyc`` files.
+   Use ``-p /`` to make the paths absolute.
+
+   This option can be used with ``-s`` but not with ``-d``.
 
 .. option:: -x regex