Skip to content

Commit 7b09784

Browse files
committed
INSTALL.md: reference dscho's excellent python on git-for-windows fixes
Dscho made fixes to msys2, cygwin, git-for-windows, and contributed several improvements to git-filter-repo that were merged in js/windows-fixes. Reference some of the fixes so that those who had issues with git-filter-repo in the past may be willing to retry, and update the installation instructions with relevant pointers. Signed-off-by: Elijah Newren <[email protected]>
1 parent 47c5a29 commit 7b09784

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

INSTALL.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,33 @@ these versions.
1919

2020
# Notes for Windows Users
2121

22-
It seems that the default python on Windows is not fully functional,
23-
and windows might not allow executing python scripts by default. See
24-
[issue 124](https://github.com/newren/git-filter-repo/issues/124),
25-
[issue 36](https://github.com/newren/git-filter-repo/issues/36), and
26-
[this git mailing list
27-
thread](https://lore.kernel.org/git/[email protected]/)
28-
for details and workarounds. I believe that Windows users installing
29-
git-filter-repo via Scoop will be okay, but those using a manual
30-
installation or pip install may run into these issues.
22+
The first hurdle for Windows users is installing a functional version
23+
of Python (it has been reported that Windows ships with a stripped
24+
down python-like program that just doesn't work). python.org probably
25+
has good instructions here, though many users report a preference
26+
getting it from the [Microsoft
27+
Store](https://docs.microsoft.com/en-us/windows/python/beginners) and
28+
seem to be successful with that (particularly since [msys2 issue
29+
#27](https://github.com/msys2/msys2-runtime/pull/27) was fixed by the
30+
Git for Windows maintainer).
31+
32+
Several users also needed to modify the first line of the
33+
git-filter-repo script to change paths, especially if installing
34+
git-filter-repo using the pip method instead of Scoop, and
35+
particularly with older versions of Git for Windows (anything less
36+
than 2.32.0.windows.1) as GitBash had an unfortunate shebang length
37+
limitation (see [git-for-windows issue
38+
#3165](https://github.com/git-for-windows/git/pull/3165)).
39+
40+
For additional details (if needed, though be aware these might not be
41+
accurate anymore given both git-for-windows and git-filter-repo
42+
fixes), see
43+
[#225](https://github.com/newren/git-filter-repo/pull/225),
44+
[#231](https://github.com/newren/git-filter-repo/pull/231),
45+
[#124](https://github.com/newren/git-filter-repo/issues/124),
46+
[#36](https://github.com/newren/git-filter-repo/issues/36), and [this
47+
git mailing list
48+
thread](https://lore.kernel.org/git/[email protected]/).
3149

3250

3351
# Manual Installation

0 commit comments

Comments
 (0)