Skip to content

Commit e3d080e

Browse files
Add simpler docker instructions to regenerate the ABI (#910)
* Add simpler docker instructions to regenerate the ABI * Update setup.rst Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Add some extra information Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
1 parent d88bf3a commit e3d080e

File tree

1 file changed

+6
-15
lines changed

1 file changed

+6
-15
lines changed

setup.rst

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -505,21 +505,12 @@ the ABI file using the same platform as the CI uses is by using docker:
505505
.. code-block:: bash
506506
507507
# In the CPython root:
508-
$ docker run -v`pwd`:/src -it ubuntu:20.04 bash
509-
$ cd /src
510-
# Install dependencies to compile CPython
511-
$ .github/workflows/posix-deps-apt.sh
512-
# Install dependencies to run the ABI regeneration
513-
$ apt-get install -yq abigail-tools python3
514-
# Ensure CPython is built with all the debugging information
515-
$ export CFLAGS="-g3 -O0"
516-
# Build Python
517-
$ ./configure --enable-shared && make
518-
# Regenerate the ABI file
519-
$ make regen-abidump
520-
521-
This will change the ``Doc/data/pythonX.Y.abi`` file with the latest changes
522-
so it can be committed to the Pull Request and the check can pass.
508+
$ docker run -v$(pwd):/src:Z -w /src --rm -it ubuntu:22.04 \
509+
bash /src/.github/workflows/regen-abidump.sh
510+
511+
Note that the ``ubuntu`` version used to execute the script matters and
512+
**must** match the version used by the CI to check the ABI. See the
513+
``.github/workflows/build.yml`` file for more information.
523514

524515
Troubleshoot the build
525516
======================

0 commit comments

Comments
 (0)