[issue19273] Update PCbuild/readme.txt
New submission from Zachary Ware: 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 ---------- assignee: docs@python components: Documentation, Windows files: pcbuild_readme.diff keywords: patch messages: 200085 nosy: docs@python, zach.ware priority: normal severity: normal status: open title: Update PCbuild/readme.txt versions: Python 3.4 Added file: http://bugs.python.org/file32148/pcbuild_readme.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Zachary Ware added the comment: Here's the patched file for easier review. ---------- Added file: http://bugs.python.org/file32149/patched_pcbuild_readme.txt _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Changes by Ned Deily <nad@acm.org>: ---------- nosy: +brian.curtin, christian.heimes, loewis, tim.golden _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti stage: -> patch review type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Tim Golden added the comment: 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. ---------- assignee: docs@python -> tim.golden _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Zachary Ware added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Zachary Ware added the comment: Here's the new patch, a few tabs converted, a few trailing spaces removed, and one sentence added to the Sub-projects section description. ---------- Added file: http://bugs.python.org/file32336/pcbuild_readme.v2.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Tim Golden added the comment: 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). ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Zachary Ware added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Tim Golden added the comment: Fine. I'll commit it later. (Probably tomorrow at this point) ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Roundup Robot added the comment: New changeset 212b4b61fa05 by Tim Golden in branch 'default': Closes issue #19273: clean up the pcbuild readme.txt (Patch by Zachary Ware) http://hg.python.org/cpython/rev/212b4b61fa05 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Tim Golden added the comment: Done. Thanks for the patch. ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Changes by Tim Golden <mail@timgolden.me.uk>: ---------- stage: patch review -> committed/rejected _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
Roundup Robot added the comment: New changeset e8307cf23af4 by Larry Hastings in branch 'default': Issue #19273: The marker comments Argument Clinic uses have been changed http://hg.python.org/cpython/rev/e8307cf23af4 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19273> _______________________________________
participants (5)
-
Ezio Melotti -
Ned Deily
-
Roundup Robot
-
Tim Golden
-
Zachary Ware