Update PCbuild/readme.txt

[zware]

BPO	19273
Nosy	@loewis, @tiran, @tjguk, @ezio-melotti, @briancurtin, @zware
Files	pcbuild_readme.diff: PCbuild/readme.txt update patch patched_pcbuild_readme.txt: Patched PCbuild/readme.txt pcbuild_readme.v2.diff: Cleaned-up patch

^{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 = 'https://github.com/tjguk'
closed_at = <Date 2013-10-25.09:30:56.553>
created_at = <Date 2013-10-16.20:52:04.572>
labels = ['type-feature', 'OS-windows', 'docs']
title = 'Update PCbuild/readme.txt'
updated_at = <Date 2014-01-07.20:42:28.631>
user = 'https://github.com/zware'

bugs.python.org fields:

activity = <Date 2014-01-07.20:42:28.631>
actor = 'python-dev'
assignee = 'tim.golden'
closed = True
closed_date = <Date 2013-10-25.09:30:56.553>
closer = 'tim.golden'
components = ['Documentation', 'Windows']
creation = <Date 2013-10-16.20:52:04.572>
creator = 'zach.ware'
dependencies = []
files = ['32148', '32149', '32336']
hgrepos = []
issue_num = 19273
keywords = ['patch']
message_count = 11.0
messages = ['200085', '200086', '201102', '201143', '201165', '201167', '201170', '201171', '201223', '201226', '207590']
nosy_count = 8.0
nosy_names = ['loewis', 'christian.heimes', 'tim.golden', 'ezio.melotti', 'brian.curtin', 'docs@python', 'python-dev', 'zach.ware']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue19273'
versions = ['Python 3.4']

[zware]

Full title: Update PCbuild/readme.txt to be more accurate, more descriptive, more complete, less repetitive, more audience-aware, and all around, hopefully, better.

What started as a simple patch to fix the supported Windows versions list, the legacy build folders list, and a couple other minor factual errors turned into a nearly complete rewrite of the whole file. The changes are too extensive to list out in this message; I'll use Rietveld to point out particular changes and my reasoning for them as soon as I'm able. Also, due to the nature of the changes, it may be simpler to review the changed file itself rather than the patch, so I'll post the patched file as well.

At least 90% of these changes also apply to 3.3, but not all; I'd be happy to backport this patch or provide a new patch that strictly addresses factual errors in 3.3, as desired.

Thanks,

Zach

[zware]

Here's the patched file for easier review.

[tjguk]

I've looked this over and, basically, +1. We could argue the toss back and forth over changes, but I think the changes do the right amount of cruft-clearing and avoid the danger of being a mere reflection of one person's aesthetic choices over another's.

If no-one objects, I propose to commit this in a day or two.

[zware]

Thanks, Tim! There are a couple minor things I'd like to get into a new patch before it's committed (there are a couple tabs that should be spaces, and I'd like to add a very short note to the Sub-Projects header about sub-projects being contained in .vcxproj and .vcxproj.filters files). I'll try to have a new patch up tonight or tomorrow.

[zware]

Here's the new patch, a few tabs converted, a few trailing spaces removed, and one sentence added to the Sub-projects section description.

[tjguk]

Thanks, Zachary. Do you see this going against just tip, or should it be
backported to 3.3 / 2.7? (I'm not sure how well the latter would be
received, truth be told).

[zware]

This patch will only apply to tip. There would need to be some changes to backport to 3.3 and I haven't actually looked at 2.7, but I expect it would require extensive changes that probably wouldn't be worth it. There are a few factual errors in 3.3 (such as supported platforms including Win2k) that should probably be corrected (and likely some in 2.7 as well), but that could be a separate issue.

I think it would be best not to backport this patch, and I'll open a separate issue to correct any errors in 2.7/3.3.

[tjguk]

Fine. I'll commit it later. (Probably tomorrow at this point)

[python-dev]

New changeset 212b4b61fa05 by Tim Golden in branch 'default':
Closes issue bpo-19273: clean up the pcbuild readme.txt (Patch by Zachary Ware)
http://hg.python.org/cpython/rev/212b4b61fa05