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

[sharktide]

This will close #133503

This PR simple updates compileall.rst to alert users to these following risks as stated by @mgorny

Removing the prefix makes paths relative to it.
-s and -p can be used simultaneously.
-p / can be used to make the path absolute.

• Issue: compileall: -s surprisingly makes path relative #133503

---

📚 Documentation preview 📚: https://cpython-previews--134756.org.readthedocs.build/

[picnixz]

Instead of having a common entry for -s and -p, we should have different entries as the warning (which should not be a warning IMO) is only for -s.

[bedevere-app]

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

[sharktide]

@picnixz IMO it should be a warning considering it could cause breaking changes to programs if people don't pay close attention

[sharktide]

I have made the requested changes; please review again

[bedevere-app]

Thanks for making the requested changes!

@picnixz: please review the changes made to this pull request.

[picnixz]

IMO it should be a warning considering it could cause breaking changes to programs if people don't pay close attention

I don't see how it's a breaking change. This has been the default behavior for ages. And warnings boxes should be used carefully as they disrupt the reading flow.

[sharktide]

Ok! I am doing it. Please review in a minute

[picnixz]

I'll review tomorrow. It's 2 AM for me

[sharktide]

Sorry! It's only 19:52 for me

*I love 24 hr time even though I live in the US*

[sharktide]

@picnixz Get some sleep and please review in your morning :)

[mgorny]

I think the documentation is inconsistent now. Previously -s and -p were documented as a single paragraph following both options. Now -s is followed by a comment, then -p is followed by the description of both options. They should either be described separately, or both notes need to be placed below -p.

[picnixz]

I would suggest the following:

.. 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

   Append 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``.

[bedevere-app]

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

[sharktide]

@picnixz Done. Review when you can, please.

[sharktide]

I have made the requested changes; please review again

[bedevere-app]

Thanks for making the requested changes!

@picnixz: please review the changes made to this pull request.

[sharktide]

@picnixz Fixed it

[sharktide]

I have made the requested changes; please review again

[bedevere-app]

Thanks for making the requested changes!

@picnixz: please review the changes made to this pull request.

[mgorny]

I think it's clear enough for me.