Add a section about how to regenerate the ABI file #903
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
AlexWaygood
reviewed
Jun 22, 2022
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
|
Thanks for the review @AlexWaygood :) |
encukou
reviewed
Jun 22, 2022
Comment on lines
+505
to
+518
| .. code-block:: bash | ||
| # In the CPython root: | ||
| $ docker run -v`pwd`:/src -it ubuntu:20.04 bash | ||
| $ cd /src | ||
| # Install dependencies to compile CPython | ||
| $ .github/workflows/posix-deps-apt.sh | ||
| # Install dependencies to run the ABI regeneration | ||
| $ apt-get install -yq abigail-tools python3 | ||
| # Ensure CPython is built with all the debugging information | ||
| $ export CFLAGS="-g3 -O0" | ||
| # Build Python | ||
| $ ./configure --enable-shared && make | ||
| # Regenerate the ABI file | ||
| $ make regen-abidump |
There was a problem hiding this comment.
That's a long script. Would you object to adding it to the source, and reducing the instructions to just e.g. docker run -v$(pwd):/src -w/src --rm ubuntu:20.04 bash /src/.github/workflows/regen-abidump.sh?
There was a problem hiding this comment.
No, I think is a good idea. Will prepare a PR
encukou
reviewed
Jun 22, 2022
| with native extensions and other tools that interact with the Python interpreter. | ||
| See the documentation about the :ref:`release candidate <rc>` phase. | ||
|
|
||
| You can regenerate the ABI file by yourself by invoking the ``regen abidump`` |
There was a problem hiding this comment.
Will fix this when I update the code block after we merge python/cpython#94135
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.