Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-109054: Document configure variables#109224

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.

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

Already on GitHub?Sign in to your account

Merged
vstinner merged 3 commits intopython:mainfromvstinner:doc_configure_vars
Sep 20, 2023

Conversation

@vstinner
Copy link
Member

@vstinnervstinner commentedSep 10, 2023•
edited by github-actionsbot
Loading

@bedevere-botbedevere-bot added awaiting core review docsDocumentation in the Doc dir labelsSep 10, 2023
@vstinnervstinner changed the titlegh-109054: Document configue optionsgh-109054: Document configue variablesSep 10, 2023
@AlexWaygoodAlexWaygood changed the titlegh-109054: Document configue variablesgh-109054: Document configure variablesSep 10, 2023
@vstinner
Copy link
MemberAuthor

I'm not sure if adding a new dedicatedVariables 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 allconfigure variables, see@erlend-aasland's comment:#109101 (comment)

Initially, I just wrote this PR to documentLIBATOMIC :-)

@vstinner
Copy link
MemberAuthor

I reorganized the doc. I'm not sure betweenenvvar andcmdoption. The current doc usesenvvar.

cc@hugovk

@vstinner
Copy link
MemberAuthor

@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?

@vstinner
Copy link
MemberAuthor

PROFILE_TASK was added in Python 3.8.

@erlend-aasland
Copy link
Contributor

@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.

Name for machine-dependent library files.


Libraries Options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

How aboutThird-party dependencies orOptions for third-party dependencies?

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Go for "Options for third-party dependencies".

@vstinner
Copy link
MemberAuthor

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

Comment on lines 329 to 328
..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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

@vstinner
Copy link
MemberAuthor

vstinner commentedSep 13, 2023•
edited
Loading

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

@vstinner
Copy link
MemberAuthor

PR rebased on the main branch.

Copy link
Member

@ezio-melottiezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

@vstinner
Copy link
MemberAuthor

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 :-)

ezio-melotti reacted with rocket emoji

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@vstinner
Copy link
MemberAuthor

@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.

@hugovk
Copy link
Member

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

Copy link
Member

@AA-TurnerAA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

A

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@vstinnervstinner merged commitd41d2e6 intopython:mainSep 20, 2023
@vstinnervstinner deleted the doc_configure_vars branchSeptember 20, 2023 16:51
@vstinner
Copy link
MemberAuthor

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

@erlend-aasland
Copy link
Contributor

LGTM! Thanks for documenting these things.

vstinner reacted with thumbs up emoji

csm10495 pushed a commit to csm10495/cpython that referenced this pull requestSep 28, 2023
Glyphack pushed a commit to Glyphack/cpython that referenced this pull requestSep 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@hugovkhugovkhugovk left review comments

@erlend-aaslanderlend-aaslanderlend-aasland left review comments

@AA-TurnerAA-TurnerAA-Turner approved these changes

@ezio-melottiezio-melottiezio-melotti approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@vstinner@erlend-aasland@hugovk@AA-Turner@ezio-melotti@bedevere-bot
[8]ページ先頭
©2009-2025 Movatter.jp