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: Improve devguide Windows instructions
Type: enhancement Stage: resolved
Components: Devguide Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: zach.ware Nosy List: PeterLovett, asvetlov, chris.jerdonek, ezio.melotti, georg.brandl, pitrou, python-dev, steve.dower, terry.reedy, webwin, willingc, zach.ware
Priority: normal Keywords: easy, patch

Created on 2013-03-29 02:13 by ezio.melotti, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue17570.diff webwin, 2013-04-07 09:14
issue17570.diff webwin, 2013-04-07 12:20
iss17570.patch willingc, 2015-04-22 14:38
iss17570v2.patch willingc, 2015-07-28 08:38
issue17570.patch PeterLovett, 2015-08-04 03:31
issue17570-2.patch PeterLovett, 2015-08-04 05:12
Messages (22)
msg185482 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-03-29 02:13
This is a follow up of #14468, and in particular of msg183031.

The instructions in the "committing" page of the devguide are unix-centric, in particular:
  1) on Windows ~/.hgrc is $HOME$/mercurial.ini;
  2) the "Settings dialogs" of TortoiseHG can/should be used to edit mercurial.ini;
  3) the devguide suggests "./python.exe Tools/scripts/patchcheck.py", but ./ doesn't work on Windows.
msg186184 - (view) Author: Volodymyr Bezkostnyy (webwin) * Date: 2013-04-07 09:14
Deleted ./ before python.exe
msg186193 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2013-04-07 11:06
At least two of the changes in the patch are incorrect because they refer to the Mac OS X "python.exe".
msg186198 - (view) Author: Volodymyr Bezkostnyy (webwin) * Date: 2013-04-07 12:20
Revert changes for Mac OS X
msg186311 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2013-04-08 15:38
Sorry, but you cannot just rewrite ./python.exe to just python.exe

At least in http://docs.python.org/devguide/buildbots you have to make probably three sections: 
1. for linux users to use just ./python
2. for Mac ./python.exe
3. for Windows <path to repo>/PCBuild/python.exe or python_d.exe (IIRC)
msg221362 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2014-06-23 15:16
What about adding a new "Platform Quirks" page listing all the known differences in usage between the three major platforms? Then in places where the instructions are a bit different per platform, like:

   ./python.exe -m test -j3

write something like

   <python> -m test -j3

and add a link to the relevant part of the Quirks page.

On the other hand, are there enough such "quirks" (meaning things that really are the same, just different invocations/etc.) to warrant a new page?
msg221363 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2014-06-23 15:17
As previously pointed out, the current patches are not adequate.
msg241807 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-04-22 14:38
This patch addresses Ezio's original issue in msg185482 to improve the Windows instructions on the "committing" page of the devguide.

I have tried to match the style of the "Getting Started" page when distinguishing UNIX (Mac OS X) commands from Windows commands. Please take extra care during review that the Windows commands documented are correct.

Barring reviewer changes, this patch should close this issue.
msg241813 - (view) Author: Steve Dower (steve.dower) * (Python committer) Date: 2015-04-22 15:51
Right at the end of the patch, ".hg/hgrc" also exists on Windows and is not the same as mercurial.ini - hgrc here is per-repo and it seems from the context that this is relevant here.

Otherwise, the rest looks good to me. I'll merge it in when I get a chance, unless someone else gets there first.
msg247508 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-07-28 08:38
Updated patch to include Steve Dower's feedback.
msg247981 - (view) Author: Peter Lovett (PeterLovett) * Date: 2015-08-04 03:31
Tiny change on case of Windows file 'mercurial.ini'
Although Windows is case-insensitive on filenames, the file itself is named in lowercase (I'm using TortoiseHg v3.4.2; I'm assuming older versions of TortoiseHg also name it in this way.)
msg247983 - (view) Author: Peter Lovett (PeterLovett) * Date: 2015-08-04 05:12
Also a similar change to patch.rst

./python.exe
should be:
PCbuild\<target>\python.exe
msg247989 - (view) Author: Steve Dower (steve.dower) * (Python committer) Date: 2015-08-04 15:27
Looks like the patchcheck section also has a "PCBuild/python.exe" that should be fixed.

Are the previous commenters satisfied with the fixes?
msg247991 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2015-08-04 15:40
In the patch:

-add configuration settings to ``~/.hgrc`` for the relevant repo(s) (remember
+add configuration settings to ``~/.hgrc`` (``mercurial.ini`` on Windows)
+for the relevant repo(s) (remember

This is nonsensical, `~/.hgrc` (`%USERPROFILE%\Mercurial.ini`) is the user-level Mercurial configuration; the settings "for the relevant repo(s)" are in `.hg/hgrc` in the repository (same on all platforms).

Btw, for me, the user-level config file on Windows has always been title-cased (`Mercurial.ini`) unless I preemptively created it myself.  Really doesn't matter, though :)
msg248255 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-08-08 07:59
Steve and Zach, If you are happy with the changes, I have no objection to committing and closing this issue.
msg248594 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-08-14 16:58
Zach, Steve, Ezio: The latest patch is ready to be committed. Thanks.
msg248595 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2015-08-14 17:01
The part of the patch that I pointed out in my previous message hasn't changed, and is wrong.
msg248597 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-08-14 17:27
Zach, Sorry for not comprehending your comment re: latest patch correctly.

Since Rietveld isn't available on devguide, which makes comparison of patches difficult (at least for me), here's some proposed wording to see if I am understanding your comment correctly. If so, I will submit a new patch. Thanks.


Suggested wording for:

Minimal Configuration
---------------------
To use Mercurial as a committer (both of your and others’ patches),
you should set up some basic options in your configuration file.
On all platforms, you must edit ~/.hgrc. On Windows, TortoiseHg has a
graphical settings dialog for most options, meaning you don’t need to edit
the file directly if you find a graphical interface more helpful.
msg248601 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2015-08-14 18:28
Sorry, I don't think we're on the same page yet :).  My issue was with a different hunk further down.

Looking at it again, the fix I want is simple enough I'll just do it at commit; I'll get it later today.
msg248611 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-08-14 20:13
New changeset 49be7fba3568 by Zachary Ware in branch 'default':
Closes #17570: Improve instructions for Windows.
https://hg.python.org/devguide/rev/49be7fba3568
msg248612 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2015-08-14 20:17
Made a couple of other fixes while fixing the point I'd already raised:

- Changed all instances of "`...`" to "*...*"
- Changed from "PCbuild\python.exe" to "python.bat"
- Wrapped a couple long lines

Thanks for the patch!
msg248620 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-08-14 21:41
Thanks Zach :D Makes more sense now ;)
History
Date User Action Args
2022-04-11 14:57:43adminsetgithub: 61770
2015-08-14 21:41:10willingcsetmessages: + msg248620
2015-08-14 20:17:05zach.waresetmessages: + msg248612
2015-08-14 20:13:44python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg248611

resolution: fixed
stage: commit review -> resolved
2015-08-14 18:28:34zach.waresetassignee: willingc -> zach.ware
messages: + msg248601
stage: needs patch -> commit review
2015-08-14 17:27:29willingcsetmessages: + msg248597
2015-08-14 17:01:31zach.waresetstage: commit review -> needs patch
2015-08-14 17:01:07zach.waresetmessages: + msg248595
2015-08-14 16:58:07willingcsetmessages: + msg248594
stage: patch review -> commit review
2015-08-08 07:59:38willingcsetmessages: + msg248255
2015-08-04 15:40:08zach.waresetmessages: + msg247991
2015-08-04 15:27:33steve.dowersetmessages: + msg247989
2015-08-04 05:12:22PeterLovettsetfiles: + issue17570-2.patch

messages: + msg247983
2015-08-04 03:31:57PeterLovettsetfiles: + issue17570.patch
nosy: + PeterLovett
messages: + msg247981

2015-07-28 08:38:36willingcsetfiles: + iss17570v2.patch

messages: + msg247508
2015-04-22 15:51:15steve.dowersetmessages: + msg241813
2015-04-22 14:38:02willingcsetfiles: + iss17570.patch

nosy: + willingc
messages: + msg241807

assignee: willingc
stage: needs patch -> patch review
2015-03-07 16:57:51ezio.melottisetnosy: + steve.dower
2014-06-23 15:17:38zach.waresetmessages: + msg221363
stage: patch review -> needs patch
2014-06-23 15:16:02zach.waresetmessages: + msg221362
2014-06-23 15:02:30berker.peksagsetnosy: + zach.ware

stage: needs patch -> patch review
2013-04-08 15:38:45asvetlovsetmessages: + msg186311
2013-04-07 12:20:41webwinsetfiles: + issue17570.diff

messages: + msg186198
2013-04-07 11:06:26georg.brandlsetnosy: + georg.brandl
messages: + msg186193
2013-04-07 09:14:44webwinsetfiles: + issue17570.diff

nosy: + asvetlov, webwin
messages: + msg186184

keywords: + patch
2013-03-29 02:13:34ezio.melotticreate