classification
Title: Windows Build instruction typo
Type: Stage: resolved
Components: Devguide, Windows Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: brian.curtin, eli.bendersky, ezio.melotti, michael.driscoll, python-dev
Priority: normal Keywords: patch

Created on 2012-05-22 19:12 by michael.driscoll, last changed 2012-05-23 18:18 by eli.bendersky. This issue is now closed.

Files
File name Uploaded Description Edit
setup.patch michael.driscoll, 2012-05-22 19:12 patch for Windows setup typo
ms_vc2010.png michael.driscoll, 2012-05-23 02:44 MS VC++ 2010 screenshot
setup.patch michael.driscoll, 2012-05-23 11:39 patch
setup.patch michael.driscoll, 2012-05-23 15:20
Messages (14)
msg161373 - (view) Author: Michael Driscoll (michael.driscoll) * Date: 2012-05-22 19:12
In http://docs.python.org/devguide/setup.html#windows the devguide mentions that the user must go to the "Build" menu to run "Build Solution". When I tried doing that with Visual C++ 2010 per the instructions, I discovered that there is no "Build" menu and the menu item is actually under the "Debug" menu. I have attached my first attempt at a patch in the hopes that this might be fixed.
msg161388 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2012-05-23 01:51
Would you mind taking a screenshot of where "Build Solution" appears? You'll probably need to hold CTRL+print screen to make sure the menu doesn't retract. As seen in http://i.imgur.com/XvXa5.png I have the menu as described in the guide and it's the one I've seen others have as well.

The guide used to mention everything by keyboard shortcuts which can be different for everyone depending on the keyboard layout they choose at install time (or through the options later on).
msg161390 - (view) Author: Michael Driscoll (michael.driscoll) * Date: 2012-05-23 02:44
@Brian - Sorry I didn't include a screenshot earlier. I was running it on a machine without good screen capturing software. I've rectified that and attached a screenshot for you. I suspect that there's a difference between the VC++ 2010 Express Edition and a full suite.
msg161391 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2012-05-23 02:54
Weird that they would do that. Given that there is a difference, we should probably list both. Something like "choose the Build Solution option from either the Build or Debug menu depending on your Visual Studio version."

Your patch seems to solve something different than you've been mentioning. That drop-down is technically the "Solution Configuration" so we could name it as that, but I figured "build configuration" worked because it's a configuration of how the build will be done.
msg161392 - (view) Author: Michael Driscoll (michael.driscoll) * Date: 2012-05-23 03:24
Yeah, my patch didn't turn out the way I expected. I replaced "Build" with "Debug" and then noticed that it also referred to some kind of "build" drop-down that didn't seem like the right term. I couldn't figure out what the right term was though. Would you like me to fix those two items using your wording? Or we could just leave it as it is in the original and just fix the the part I mentioned originally.
msg161393 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2012-05-23 03:31
May as well fix them both.
msg161401 - (view) Author: Michael Driscoll (michael.driscoll) * Date: 2012-05-23 11:39
Here's a new patch that I think addresses both issues. Thanks for your insights.
msg161415 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-05-23 14:58
Nitpicking: the drop down (in both VC++ 2008 & 2010 express) is named "Solution Configurations" [note the 's' in the end]

But this name does now appear anywhere - only if you hover on the dropbox. I don't mind either way - either leave it what it was, or change "build" to "Solution Configurations", but do spell it correctly :)
msg161416 - (view) Author: Michael Driscoll (michael.driscoll) * Date: 2012-05-23 15:20
@ Eli - Sorry about that. I just went with Brian's wording on that. I didn't realize it was plural. My experience with Visual Studio is limited, although I hope to rectify that at some point. Anyway, I corrected the patch and attached it. Thanks!
msg161417 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-05-23 15:25
LGTM. Brian, any objections to commit?

P.S. Michael: I usually like numbering successive versions of a patch (like setup.1.patch, setup.2.patch, or a similar scheme) - this makes it easier to refer to more than one version in a discussion without getting confused. This is just a tip for future patches.
msg161419 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2012-05-23 15:26
Looks good to me. Feel free to commit it, Eli.
msg161429 - (view) Author: Michael Driscoll (michael.driscoll) * Date: 2012-05-23 16:11
Thanks for the tip Eli. I'll try to remember to number my patches next time. This is my first time doing this.
msg161445 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-05-23 18:16
New changeset e55c65fc3cb4 by Eli Bendersky in branch 'default':
Issue #14884: fixed a couple of typos in the Windows build instructions. Patch by Michael Driscoll
http://hg.python.org/devguide/rev/e55c65fc3cb4
msg161447 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-05-23 18:18
Done (with a tiny fix inserting parens to avoid ambiguity in a sentence).

Thanks for the contribution!
History
Date User Action Args
2012-05-23 18:18:14eli.benderskysetstatus: open -> closed
resolution: fixed
messages: + msg161447

stage: patch review -> resolved
2012-05-23 18:16:51python-devsetnosy: + python-dev
messages: + msg161445
2012-05-23 16:11:15michael.driscollsetmessages: + msg161429
2012-05-23 15:26:50brian.curtinsetassignee: brian.curtin ->
messages: + msg161419
2012-05-23 15:25:05eli.benderskysetmessages: + msg161417
2012-05-23 15:20:43michael.driscollsetfiles: + setup.patch

messages: + msg161416
2012-05-23 14:58:29eli.benderskysetmessages: + msg161415
2012-05-23 11:39:28michael.driscollsetfiles: + setup.patch

messages: + msg161401
2012-05-23 08:39:00eli.benderskysetnosy: + eli.bendersky
2012-05-23 03:31:55brian.curtinsetmessages: + msg161393
2012-05-23 03:24:14michael.driscollsetmessages: + msg161392
2012-05-23 02:54:02brian.curtinsetmessages: + msg161391
2012-05-23 02:44:43michael.driscollsetfiles: + ms_vc2010.png

messages: + msg161390
2012-05-23 01:51:40brian.curtinsetassignee: brian.curtin
components: + Windows
versions: - Python 3.4
nosy: + brian.curtin

messages: + msg161388
stage: patch review
2012-05-22 19:12:26michael.driscollcreate