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.

Sign up for GitHub

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

Jump to bottom

inconsistent case of PCbuild/ directory #75750

Closed
gronke mannequin opened this issue Sep 24, 2017 · 7 comments
Closed

inconsistent case of PCbuild/ directory #75750

gronke mannequin opened this issue Sep 24, 2017 · 7 comments
Labels
3.7 (EOL) end of life build The build process and cross-build docs Documentation in the Doc dir OS-windows type-feature A feature request or enhancement

Comments

@gronke
Copy link
Mannequin

gronke mannequin commented Sep 24, 2017

BPO 31569
Nosy @pfmoore, @tjguk, @zware, @serhiy-storchaka, @zooba, @gronke
PRs
  • bpo-31569: globally fix case for PCbuild where it was PCBuild #3711
    		•

    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 = <Date 2017-09-25.18:36:04.288>
created_at = <Date 2017-09-24.11:44:44.430>
labels = ['type-feature', '3.7', 'OS-windows', 'build', 'docs']
title = 'inconsistent case of PCbuild/ directory'
updated_at = <Date 2017-09-25.18:36:04.287>
user = 'https://github.com/gronke'

    bugs.python.org fields:

    activity = <Date 2017-09-25.18:36:04.287>
actor = 'steve.dower'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-09-25.18:36:04.288>
closer = 'steve.dower'
components = ['Build', 'Documentation', 'Windows']
creation = <Date 2017-09-24.11:44:44.430>
creator = 'gronke'
dependencies = []
files = []
hgrepos = []
issue_num = 31569
keywords = []
message_count = 7.0
messages = ['302851', '302852', '302857', '302959', '302960', '302961', '302963']
nosy_count = 7.0
nosy_names = ['paul.moore', 'tim.golden', 'docs@python', 'zach.ware', 'serhiy.storchaka', 'steve.dower', 'gronke']
pr_nums = ['3711']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue31569'
versions = ['Python 2.7', 'Python 3.3', 'Python 3.4', 'Python 3.5', 'Python 3.6', 'Python 3.7']
    @gronke
    Copy link
    Mannequin Author

    gronke mannequin commented Sep 24, 2017

    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.

    @gronke gronke mannequin added the 3.7 (EOL) end of life label Sep 24, 2017
    @gronke gronke mannequin assigned docspython Sep 24, 2017
    @gronke gronke mannequin added build The build process and cross-build docs Documentation in the Doc dir OS-windows type-feature A feature request or enhancement labels Sep 24, 2017
    @serhiy-storchaka
    Copy link
    Member

    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.

    @pfmoore
    Copy link
    Member

    pfmoore commented Sep 24, 2017

    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.

    @zooba
    Copy link
    Member

    zooba commented Sep 25, 2017

    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.

    @zware
    Copy link
    Member

    zware commented Sep 25, 2017

    Personally, *I'd* prefer PC -> Windows and PCbuild -> Windows\build :)

    I'm also good with the PR as is.

    @pfmoore
    Copy link
    Member

    pfmoore commented Sep 25, 2017

    OK, having re-read the PR, I'm fine with applying it as is, too.

    @pfmoore
    Copy link
    Member

    pfmoore commented Sep 25, 2017

    New changeset f1502d0 by Paul Moore (Stefan Grönke) in branch 'master':
    bpo-31569: correct PCBuild/ case to PCbuild/ in build scripts and docs (GH-3711)
    f1502d0

    @zooba zooba closed this as completed Sep 25, 2017
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life build The build process and cross-build docs Documentation in the Doc dir OS-windows type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @pfmoore @zooba @serhiy-storchaka @zware