Improve documentation of CFLAGS_NODIST, LDFLAGS_NODIST

@vstinner

BPO	46381
Nosy	@vstinner, @DiddiLeija

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2022-01-14.18:38:16.475>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = 'Improve documentation of CFLAGS_NODIST, LDFLAGS_NODIST'
updated_at = <Date 2022-01-17.15:21:27.848>
user = 'https://bugs.python.org/matthiaskoeppe'

bugs.python.org fields:

activity = <Date 2022-01-17.15:21:27.848>
actor = 'vstinner'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2022-01-14.18:38:16.475>
creator = 'matthiaskoeppe'
dependencies = []
files = []
hgrepos = []
issue_num = 46381
keywords = []
message_count = 2.0
messages = ['410586', '410799']
nosy_count = 4.0
nosy_names = ['vstinner', 'docs@python', 'DiddiLeija', 'matthiaskoeppe']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue46381'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

The documentation of

https://docs.python.org/3.11/using/configure.html#envvar-CFLAGS
https://docs.python.org/3.11/using/configure.html#envvar-CFLAGS_NODIST
https://docs.python.org/3.11/using/configure.html#envvar-LDFLAGS
https://docs.python.org/3.11/using/configure.html#envvar-LDFLAGS_NODIST
should explain more clearly that flags such as -I, -L, etc. and strict compiler flags such as -Werror... should not be put into CFLAGS, LDFLAGS, or it will make the resulting Python unusable for compiling user packages with extension modules via distutils and setuptools.

Various downstream packagers have provided misconfigured Pythons:

Homebrew (https://trac.sagemath.org/ticket/31132, Python: Change Homebrew includes into NODIST flags Homebrew/homebrew-core#68528, resolved)
Cygwin (https://trac.sagemath.org/ticket/33078, https://cygwin.com/pipermail/cygwin/2021-December/250302.html, resolved in a proposed package update)
pyenv (https://trac.sagemath.org/ticket/32531, pythons built with pyenv's python-build leak CFLAGS/LDFLAGS into user packages via sysconfig pyenv/pyenv#2204, open)

So this appears to be a documentation / user education issue in CPython.

@isuruf

Various downstream packagers have provided misconfigured Pythons:

Homebrew (https://trac.sagemath.org/ticket/31132, Python: Change Homebrew includes into NODIST flags Homebrew/homebrew-core#68528, resolved)

Cygwin (https://trac.sagemath.org/ticket/33078, https://cygwin.com/pipermail/cygwin/2021-December/250302.html, resolved in a proposed package update)

pyenv (https://trac.sagemath.org/ticket/32531, pythons built with pyenv's python-build leak CFLAGS/LDFLAGS into user packages via sysconfig pyenv/pyenv#2204, open)

Also:

conda (https://trac.sagemath.org/ticket/31539) @isuruf

@jaraco

@jaraco Is there setuptools/distutils documentation that we can refer to explain how sysconfig CFLAGS and LDFLAGS are used?

It appears not. Distutils docs have been migrated to setuptools docs. When I searched there, I got no results, so it appears to be undocumented. I'd appreciate contributions in this area, especially if you invest the time to discover the details based on the code.

Current documentation:

Current documentation:

https://docs.python.org/dev/using/configure.html#envvar-CFLAGS_NODIST

https://docs.python.org/dev/using/configure.html#envvar-PY_CFLAGS_NODIST

https://docs.python.org/dev/using/configure.html#envvar-LDFLAGS_NODIST

https://docs.python.org/dev/using/configure.html#envvar-PY_LDFLAGS_NODIST

Yes, this is what my PR #92754 extends.

@jaraco

@jaraco Is there setuptools/distutils documentation that we can refer to explain how sysconfig CFLAGS and LDFLAGS are used?

It appears not. Distutils docs have been migrated to setuptools docs. When I searched there, I got no results, so it appears to be undocumented. I'd appreciate contributions in this area, especially if you invest the time to discover the details based on the code.

I'll prepare a PR. Is it already possible to refer to the (sparse) docstrings such as those found in https://github.com/pypa/setuptools/blob/main/setuptools/_distutils/unixccompiler.py? (Is it formatted with sphinx somewhere?)

Yes, this is what my PR #90539 extends.

The link is this issue, not a PR. I'm confused.

Yes, this is what my PR #90539 extends.

The link is this issue, not a PR. I'm confused.

Sorry, edited. I meant #92754

@jaraco

@jaraco Is there setuptools/distutils documentation that we can refer to explain how sysconfig CFLAGS and LDFLAGS are used?

It appears not. Distutils docs have been migrated to setuptools docs. When I searched there, I got no results, so it appears to be undocumented. I'd appreciate contributions in this area, especially if you invest the time to discover the details based on the code.

That's now pypa/setuptools#3368

pythongh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (

gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (#92754

pythongh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (

gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (GH-…

Revert 30935 defer bpo45162 to 312 (#94285)

Navigation Menu

Repository navigation

Improve documentation of CFLAGS_NODIST, LDFLAGS_NODIST #90539

11 remaining items

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Improve documentation of CFLAGS_NODIST, LDFLAGS_NODIST #90539

Description

Activity

matthiaskoeppe commented on Jan 14, 2022

11 remaining items

mkoeppe commented on May 12, 2022

jaraco commented on Jun 12, 2022

vstinner commented on Jun 13, 2022

mkoeppe commented on Jun 13, 2022

mkoeppe commented on Jun 13, 2022

vstinner commented on Jun 13, 2022

mkoeppe commented on Jun 13, 2022

mkoeppe commented on Jun 13, 2022

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions