classification
Title: inconsistent case of PCbuild/ directory
Type: enhancement Stage: resolved
Components: Build, Documentation, Windows Versions: Python 3.7, Python 3.6, Python 3.5, Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gronke, paul.moore, serhiy.storchaka, steve.dower, tim.golden, zach.ware
Priority: normal Keywords:

Created on 2017-09-24 11:44 by gronke, last changed 2017-09-25 18:36 by steve.dower. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 3711 merged gronke, 2017-09-24 11:44
Messages (7)
msg302851 - (view) Author: Stefan Grönke (gronke) * Date: 2017-09-24 11:44
While reading the build documentation for Windows, I've noticed the `PCbuild/` directory to be mentioned with a different case than the directory in the repository (`PCBuild/` instead of `PCbuild/`).

Every occasion of `PCBuild` should be replaced with `PCbuild`, so that builds can work on case-sensitive filesystems as well.
msg302852 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-09-24 11:51
Wouldn't be easier to make changes in the opposite direction? Change PCbuild to PCBuild?

The file systems on Windows are case-insensitive, so this hardly an error.
msg302857 - (view) Author: Paul Moore (paul.moore) * (Python committer) Date: 2017-09-24 12:37
I would strongly prefer the docs to be changed to match the implementation rather than the other way round. However, I don't see the use case for this - what case sensitive filesystem would anybody be building the Windows version of Python on?


I'm -1 on changing the actual build scripts, as that introduces risk for no actual benefit. I'm +0 on changing the docs, assuming it's possible to make things consistent with a doc-only change. But I can't imagine anyone reading those docs would expect a filesystem to be case sensitive, so I doubt it would matter in practice.
msg302959 - (view) Author: Steve Dower (steve.dower) * (Python committer) Date: 2017-09-25 16:18
I'm okay with the PR as it stands, especially the parts that affect GitHub and appveyor, as those are almost certainly using case sensitive comparisons.

It's definitely not easier to update the case of a file that is in git, and doing so will very likely break users (we had to do a case-folding pass over the Mercurial repository because while it could handle case changes, git could not import the ones we had in history).

Personally I'd prefer it to have always been PCBuild rather than PCbuild, and it's very likely that I've introduced most of the 'incorrect' ones. But what's done is done and we should avoid the potential distraction of mismatched case throughout the rest of our codebase.
msg302960 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2017-09-25 16:23
Personally, *I'd* prefer PC -> Windows and PCbuild -> Windows\build :)

I'm also good with the PR as is.
msg302961 - (view) Author: Paul Moore (paul.moore) * (Python committer) Date: 2017-09-25 16:47
OK, having re-read the PR, I'm fine with applying it as is, too.
msg302963 - (view) Author: Paul Moore (paul.moore) * (Python committer) Date: 2017-09-25 16:58
New changeset f1502d097c29b266a5748312ee2451a2d6ac0af6 by Paul Moore (Stefan Grönke) in branch 'master':
bpo-31569: correct PCBuild/ case to PCbuild/ in build scripts and docs (GH-3711)
https://github.com/python/cpython/commit/f1502d097c29b266a5748312ee2451a2d6ac0af6
History
Date User Action Args
2017-09-25 18:36:04steve.dowersetstatus: open -> closed
resolution: fixed
stage: resolved
2017-09-25 16:58:13paul.mooresetmessages: + msg302963
2017-09-25 16:47:40paul.mooresetmessages: + msg302961
2017-09-25 16:23:20zach.waresetmessages: + msg302960
2017-09-25 16:18:27steve.dowersetmessages: + msg302959
2017-09-24 12:37:51paul.mooresetmessages: + msg302857
2017-09-24 11:51:24serhiy.storchakasetnosy: + serhiy.storchaka
messages: + msg302852
2017-09-24 11:44:44gronkecreate