Add a section about how to regenerate the ABI file - #903
Conversation
Sorry, something went wrong.
Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
AlexWaygood
left a comment
There was a problem hiding this comment.
Some typos :)
Sorry, something went wrong.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
|
Thanks for the review @AlexWaygood :) |
Sorry, something went wrong.
| .. 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?
Sorry, something went wrong.
There was a problem hiding this comment.
No, I think is a good idea. Will prepare a PR
Sorry, something went wrong.
There was a problem hiding this comment.
Sorry, something went wrong.
| 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.
regen-abidump, right?
Sorry, something went wrong.
There was a problem hiding this comment.
Yup
Sorry, something went wrong.
There was a problem hiding this comment.
Will fix this when I update the code block after we merge python/cpython#94135
Sorry, something went wrong.
No description provided.