gh-109054: Document configure variables by vstinner · Pull Request #109224 · python/cpython · GitHub

Issue: ARM Raspbian 3.x fails to build _testcapi extension: undefined symbol: __atomic_fetch_or_8 #109054

📚 Documentation preview 📚: https://cpython-previews--109224.org.readthedocs.build/

I'm not sure if adding a new dedicated Variables section is the best home for all these variables.

I chose to use .. cmdoption:: NAME syntax to avoid name conflicts with compiler flags defined with .. envvar:: NAME such as: https://docs.python.org/dev/using/configure.html#compiler-flags

I used ./configure --help | grep '^\s\+[A-Z]\{2,\}' command to list all configure variables, see @erlend-aasland's comment: #109101 (comment)

Initially, I just wrote this PR to document LIBATOMIC :-)

I reorganized the doc. I'm not sure between envvar and cmdoption. The current doc uses envvar.

cc @hugovk

@erlend-aasland: it seems like the whole "3.3.4. Libraries Options" section is new in Python 3.11, all xxx_CFLAGS and xxx_LIBS, no?

PROFILE_TASK was added in Python 3.8.

@erlend-aasland: it seems like the whole "3.3.4. Libraries Options" section is new in Python 3.11, all xxx_CFLAGS and xxx_LIBS, no?

Yes, it came with the setup.py migration we did.

How about Third-party dependencies or Options for third-party dependencies?

Go for "Options for third-party dependencies".

@erlend-aasland: I updated my PR, would you mind to review it again?

This is going away with #109344:

Suggested change

      
            .. cmdoption:: LIBATOMIC
          
               Linker flags when ``cpython/pyatomic.h`` header file is used.
          
               Default: ``LIBATOMIC='-latomic'`` if ``libatomic`` is needed, or
          
               ``LIBATOMIC=''`` otherwise (also the default when Python is cross-compiled).
          
               .. versionadded:: 3.13

I understand that you want me to remove this variable in the doc, so I removed it.

Oh sorry for the noise, I tried a Git tool which messed up with my PR. I fixed my PR.

PR rebased on the main branch.

I would keep the PR focused and handle capitalization issues in a separate PR.
New titles should follow the existing conventions, even if it doesn't match the preferred capitalization specified by the devguide. A follow-up PR can fix it.

I would keep the PR focused and handle capitalization issues in a separate PR.

Hum, ok, I reverted these changes. I didn't expect that changing a few titles would be so controversial :-)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

@erlend-aasland @hugovk @ezio-melotti: I rebased my PR on the main branch, squashed commits, I reverted title casing change (don't use Titlecase Anymore). Please review the updated PR.

@ezio-melotti: I applied your sugsestions to use :samp:, thanks.

Looks good, although I'll leave approval for someone who knows about these flags 👍

Looks good Sphinx-wise. (But same caveat as Hugo wrt the flags)

A

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Thanks for the reviews. If someone has more remarks, feel free to propose a PR :-)

LGTM! Thanks for documenting these things.

vstinner added the skip news label Sep 10, 2023

vstinner requested review from corona10, erlend-aasland and tiran as code owners September 10, 2023 10:56

bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Sep 10, 2023

bedevere-bot mentioned this pull request Sep 10, 2023

ARM Raspbian 3.x fails to build _testcapi extension: undefined symbol: __atomic_fetch_or_8 #109054

Closed

vstinner changed the title gh-109054: Document configue options gh-109054: Document configue variables Sep 10, 2023

vstinner force-pushed the doc_configure_vars branch from 9b3fc31 to 3485011 Compare September 10, 2023 10:56

AlexWaygood changed the title gh-109054: Document configue variables gh-109054: Document configure variables Sep 10, 2023

This was referenced Sep 10, 2023

gh-109054: configure checks if libatomic is needed #109101

Merged

gh-109054: Don't use libatomic on cross-compilation #109211

Merged

vstinner commented Sep 10, 2023

View reviewed changes

Comment thread Doc/using/configure.rst Outdated

Comment thread Doc/using/configure.rst Outdated

Comment thread Doc/using/configure.rst Outdated

Comment thread Doc/using/configure.rst Outdated

Comment thread Doc/using/configure.rst Outdated

vstinner commented Sep 10, 2023

View reviewed changes

Comment thread Doc/using/configure.rst

erlend-aasland reviewed Sep 11, 2023

View reviewed changes

Comment thread Doc/using/configure.rst Outdated

erlend-aasland reviewed Sep 11, 2023

View reviewed changes

Comment thread Doc/using/configure.rst Outdated

erlend-aasland reviewed Sep 13, 2023

View reviewed changes

vstinner force-pushed the doc_configure_vars branch from 29756c5 to dc0ebcd Compare September 13, 2023 15:59

vstinner requested review from a team, ethanfurman, lysnikolaou, pablogsal and rhettinger as code owners September 13, 2023 15:59

vstinner removed request for 1st1, JelleZijlstra, asvetlov, gvanrossum, iritkatriel, markshannon and willingc September 13, 2023 16:27

vstinner force-pushed the doc_configure_vars branch from f0ce11d to 2796022 Compare September 19, 2023 09:47

ezio-melotti reviewed Sep 19, 2023

View reviewed changes

Comment thread Doc/using/configure.rst Outdated

vstinner force-pushed the doc_configure_vars branch from b5eda29 to 9780c71 Compare September 19, 2023 12:50

vstinner force-pushed the doc_configure_vars branch from 9780c71 to 4993499 Compare September 19, 2023 12:52

pythongh-109054 : Document configue variables

8ce10b5

vstinner force-pushed the doc_configure_vars branch from 4993499 to 8ce10b5 Compare September 19, 2023 12:53

ezio-melotti reviewed Sep 19, 2023

View reviewed changes

Comment thread Doc/using/configure.rst Outdated

Update Doc/using/configure.rst

ffba3d0

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

AA-Turner approved these changes Sep 20, 2023

View reviewed changes

ezio-melotti approved these changes Sep 20, 2023

View reviewed changes

Comment thread Doc/using/configure.rst Outdated

Update Doc/using/configure.rst

dabc436

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

vstinner merged commit d41d2e6 into python:main Sep 20, 2023

vstinner deleted the doc_configure_vars branch September 20, 2023 16:51

bedevere-app Bot removed the awaiting core review label Sep 20, 2023

csm10495 pushed a commit to csm10495/cpython that referenced this pull request Sep 28, 2023

pythongh-109054 : Document configure variables (python#109224 )

e2f97a8

Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024

pythongh-109054 : Document configure variables (python#109224 )

d0b8934

		Name for machine-dependent library files.


		Libraries Options

gh-109054: Document configure variables by vstinner · Pull Request #109224 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-109054: Document configure variables - #109224

gh-109054: Document configure variables#109224vstinner merged 3 commits intopython:mainpython/cpython:mainfrom vstinner:doc_configure_varsvstinner/cpython:doc_configure_varsCopy head branch name to clipboard

Conversation

vstinner commented Sep 10, 2023 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vstinner commented Sep 10, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vstinner commented Sep 10, 2023

Uh oh!

vstinner commented Sep 10, 2023

Uh oh!

vstinner commented Sep 10, 2023

Uh oh!

Uh oh!

erlend-aasland commented Sep 11, 2023

Uh oh!

erlend-aasland Sep 11, 2023

Choose a reason for hiding this comment

Uh oh!

vstinner Sep 11, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vstinner commented Sep 11, 2023

Uh oh!

erlend-aasland Sep 13, 2023

Choose a reason for hiding this comment

Uh oh!

vstinner Sep 13, 2023

Choose a reason for hiding this comment

Uh oh!

vstinner commented Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vstinner commented Sep 19, 2023

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vstinner commented Sep 19, 2023

Uh oh!

Uh oh!

vstinner commented Sep 19, 2023

Uh oh!

hugovk commented Sep 19, 2023

Uh oh!

AA-Turner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vstinner commented Sep 20, 2023

Uh oh!

erlend-aasland commented Sep 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gh-109054: Document configure variables#109224
vstinner merged 3 commits into
python:mainfrom
vstinner:doc_configure_vars

vstinner commented Sep 10, 2023 •
edited by github-actions Bot
Loading

vstinner commented Sep 13, 2023 •
edited
Loading