Skip to content

Recommend --config-cache for ./configure #1794

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
willingc merged 7 commits into from
Apr 25, 2026
Merged

Recommend --config-cache for ./configure #1794

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
30a3410
gh-1547: Recommend --config-cache for configure
johnslavik Apr 22, 2026
05ad04c
gh-1547: Also mention --cache-file=config.cache alias
johnslavik Apr 22, 2026
69463e6
gh-1547: Remove --config-cache from platform-specific configure commands
johnslavik Apr 22, 2026
7e8285f
gh-1547: Restructure --config-cache as optional speedup tip
johnslavik Apr 22, 2026
f9a2af1
gh-1547: Use tip admonition for --config-cache
johnslavik Apr 22, 2026
091f2fc
gh-1547: Add --config-cache to macOS platform-specific configure comm…
johnslavik Apr 22, 2026
a828b9b
Apply suggestions from review
johnslavik Apr 24, 2026
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
10 changes: 10 additions & 0 deletions getting-started/setup-building.rst
View file
Open in desktop
Comment thread
johnslavik marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,16 @@ Configuration is typically::
More flags are available to ``configure``, but this is the minimum you should
do to get a pydebug build of CPython.

.. tip::
To speed up repeated ``configure`` runs, use ``--config-cache`` (short:
``-C``, equivalent: ``--cache-file=config.cache``)::
Comment thread
johnslavik marked this conversation as resolved.
Outdated

$ ./configure --config-cache --with-pydebug

This caches results in a ``config.cache`` file. If you switch compilers or
significantly change your build environment, delete ``config.cache`` before
Comment thread
johnslavik marked this conversation as resolved.
Outdated
re-running ``configure``.

.. note::
You might need to run ``make clean`` before or after re-running ``configure``
in a particular build directory.
Expand Down
4 changes: 2 additions & 2 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ instructions please see the :ref:`setup guide <setup>`.

.. code-block:: shell

./configure --with-pydebug && make -j $(nproc)
./configure --config-cache --with-pydebug && make -j $(nproc)

.. tab:: macOS

.. code-block:: shell

./configure --with-pydebug && make -j8
./configure --config-cache --with-pydebug && make -j8

.. tab:: Windows

Expand Down
Loading