Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that distutils.(plat)include is for CPython's headers #29578

Merged
merged 1 commit into from
Nov 23, 2021

Conversation

encukou
Copy link
Member

@encukou encukou commented Nov 16, 2021

Change the docs to note that "include" and "platinclude" are for CPython's headers, and not necessarily for headers of third-party libraries.

See discussion in: https://discuss.python.org/t/clarification-on-a-wheels-header-data/9305/19

Change the docs to note that "include" and "platinclude" are
for CPython's headers, and not necessarily for headers of
third-party libraries.

See discussion in: https://discuss.python.org/t/clarification-on-a-wheels-header-data/9305/19
Copy link
Member

@FFY00 FFY00 left a comment

Choose a reason for hiding this comment

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

Ugh, this is not super accurate as these directories might include package headers, but I have no clue on how to fix this otherwise. These directories are indeed intended for the Python C-API, not package headers, so I think this change is correct.

It would not be a bad idea to wait for https://bugs.python.org/issue44445 to be resolved to make this change, but I don't think it's required, it's up to you.

@merwok merwok changed the title Clarify that discutils.(plat)include is for CPython's headers Clarify that distutils.(plat)include is for CPython's headers Nov 16, 2021
@encukou
Copy link
Member Author

encukou commented Nov 23, 2021

If bpo-44445 is resolved, it will need a separate PR with a changelog entry.

(I confess that I have no idea how installing C headers for extensions should work – to me this seems rather out of scope for Python's packaging ecosystem. So I can't really contribute to that issue.)

@encukou encukou merged commit 2c047f6 into python:main Nov 23, 2021
@encukou encukou deleted the sysconfig-include-doc branch November 23, 2021 10:28
remykarem pushed a commit to remykarem/cpython that referenced this pull request Dec 7, 2021
…GH-29578)

Change the docs to note that "include" and "platinclude" are
for CPython's headers, and not necessarily for headers of
third-party libraries.

See discussion in: https://discuss.python.org/t/clarification-on-a-wheels-header-data/9305/19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants