Skip to content

Recomend podman instead of docker and remove mentions to Docker images #1442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2024
Merged

Recomend podman instead of docker and remove mentions to Docker images #1442

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0113891
use GHCR images instead of Docker images
picnixz Oct 13, 2024
d571a64
Address Ezio and Hugo's reviews
picnixz Oct 13, 2024
3f8c80c
Address Ezio's review (round 2)
picnixz Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions _extensions/ubuntu_version.py
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import sys
import time

sys.path.insert(0, '_extensions')

extensions = [
'ubuntu_version',
'notfound.extension',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
Expand Down Expand Up @@ -203,7 +199,3 @@
copybutton_prompt_text = "$ "
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#honor-line-continuation-characters-when-copying-multline-snippets
copybutton_line_continuation_character = "\\"

# Must be synchronized with the Ubuntu image version in
# https://github.com/python/cpython/blob/main/Tools/build/regen-configure.sh
configure_ubuntu_version = "22.04"
40 changes: 13 additions & 27 deletions developer-workflow/extension-modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,17 @@ Now that the configuration is in place, it remains to compile the project:

* ``make regen-configure`` updates the :cpy-file:`configure` script.

The :cpy-file:`configure` script must be generated using a specific version
of ``autoconf``. To that end, the :cpy-file:`Tools/build/regen-configure.sh`
script which the ``regen-configure`` rule is based on either requires Docker
or Podman, the latter being assumed by default.

.. tip::

We recommend installing `Podman <https://podman.io/docs/installation>`_
instead of Docker since the former does not require a background service
and avoids creating files owned by the ``root`` user in some cases.

* ``make regen-all`` is responsible for regenerating header files and
invoking other scripts, such as :ref:`Argument Clinic <clinic>`.
Execute this rule if you do not know which files should be updated.
Expand Down Expand Up @@ -590,38 +601,13 @@ by executing :cpy-file:`Tools/build/regen-configure.sh`:
./Tools/build/regen-configure.sh # create an up-to-date 'configure'
./configure # create an up-to-date 'Makefile'

``make regen-configure`` and missing permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Since this rule requires `Docker <https://docs.docker.com/desktop>`_ to be
running, the following can be done on Linux platforms (``systemctl``-based):

.. code-block:: shell

systemctl status docker # is the Docker service running?
sudo systemctl start docker # start it if it is not
sudo systemctl restart docker # or restart it if the issue persists
``make regen-configure`` and missing permissions with Docker
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If Docker complains about missing permissions, this Stack Overflow post
could be useful in solving the issue: `How to fix docker: permission denied
<https://stackoverflow.com/q/48957195/9579194>`_.

Once the Docker service is running, check that you have an `Ubuntu
$CONFIGURE_UBUNTU_VERSION$ image <https://hub.docker.com/_/ubuntu>`_,
or pull it if it is not case:

.. code-block:: shell

# check for the Docker image presence
docker images ubuntu:$CONFIGURE_UBUNTU_VERSION$
# pull the Docker image if needed
docker image pull ubuntu:$CONFIGURE_UBUNTU_VERSION$

.. tip::

If the issue persists, you may try `podman <https://podman.io/>`_.
The commands for listing or pulling an image are the same as ``docker``.

Missing ``Py_BUILD_CORE`` define when using internal headers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
Loading