This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Devguide: Enhance Quick Start portion of instructions for Windows
Type: Stage: resolved
Components: Devguide Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: ezio.melotti, kathweaver, pitrou, python-dev
Priority: normal Keywords: patch

Created on 2014-03-14 16:22 by kathweaver, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
kweaver.patch kathweaver, 2014-03-14 22:12 Patch
Messages (6)
msg213567 - (view) Author: Kathleen Weaver (kathweaver) * Date: 2014-03-14 16:22
Current text reads:

On Windows, open the solution file PCbuild\pcbuild.sln in Visual Studio, select Debug, and Build ‣ Build Solution. Run Tools\buildbot\external.bat or Tools\buildbot\external-amd64.bat to download and compile 3rd party libraries.

While it works correctly, this does generate errors in the build process which can be confusing.  This is documented in the read me, and the Getting Started.  I believe it should be mentioned here in the quick start
msg213568 - (view) Author: Kathleen Weaver (kathweaver) * Date: 2014-03-14 16:29
Added sentence to indicate errors are thrown but it still works.
msg213576 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2014-03-14 17:43
Thanks for the patch! You will also have to sign a contributor's agreement at http://www.python.org/psf/contrib/contrib-form/

A nit: there's a dedicated "note" markup tag that you can use:
http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions.

When you say "Visual Studio will throw errors", does it occur in all cases, or in specific circumstances? (e.g. "Visual Studio will throw errors if some optional third-party libraries are missing")
msg213595 - (view) Author: Kathleen Weaver (kathweaver) * Date: 2014-03-14 22:12
I like the mark up but I don't think this warrants quite that much attention.

I changed the wording to "may throw errors"
msg213697 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-03-16 01:41
New changeset a775fe9e7f86 by Antoine Pitrou in branch 'default':
Issue #20926: Enhance Quick Start portion of instructions for Windows.  Patch by Kathleen Weaver.
http://hg.python.org/devguide/rev/a775fe9e7f86
msg213698 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2014-03-16 01:42
Ok, I've committed the patch. Thank you!
History
Date User Action Args
2022-04-11 14:58:00adminsetgithub: 65125
2014-03-16 01:42:18pitrousetstatus: open -> closed
resolution: fixed
messages: + msg213698

stage: resolved
2014-03-16 01:41:52python-devsetnosy: + python-dev
messages: + msg213697
2014-03-14 22:13:13kathweaversetfiles: - kweaver.patch
2014-03-14 22:12:51kathweaversetfiles: + kweaver.patch

messages: + msg213595
2014-03-14 17:43:20pitrousetnosy: + pitrou
messages: + msg213576
2014-03-14 16:45:09loewissettitle: Debguide: Enhance Quick Start portion of instructions for Windows -> Devguide: Enhance Quick Start portion of instructions for Windows
2014-03-14 16:45:01loewissettitle: Enhance Quick Start portion of instructions for Windows -> Debguide: Enhance Quick Start portion of instructions for Windows
2014-03-14 16:29:38kathweaversetfiles: + kweaver.patch
keywords: + patch
messages: + msg213568
2014-03-14 16:22:47kathweavercreate