Skip to content

Commit

Permalink
INSTALL.md: reference dscho's excellent python on git-for-windows fixes
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
newren committed Jun 7, 2021
1 parent 47c5a29 commit 7b09784
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,33 @@ these versions.

# Notes for Windows Users

It seems that the default python on Windows is not fully functional,
and windows might not allow executing python scripts by default. See
[issue 124](https://github.com/newren/git-filter-repo/issues/124),
[issue 36](https://github.com/newren/git-filter-repo/issues/36), and
[this git mailing list
thread](https://lore.kernel.org/git/[email protected]/)
for details and workarounds. I believe that Windows users installing
git-filter-repo via Scoop will be okay, but those using a manual
installation or pip install may run into these issues.
The first hurdle for Windows users is installing a functional version
of Python (it has been reported that Windows ships with a stripped
down python-like program that just doesn't work). python.org probably
has good instructions here, though many users report a preference
getting it from the [Microsoft
Store](https://docs.microsoft.com/en-us/windows/python/beginners) and
seem to be successful with that (particularly since [msys2 issue
#27](https://github.com/msys2/msys2-runtime/pull/27) was fixed by the
Git for Windows maintainer).

Several users also needed to modify the first line of the
git-filter-repo script to change paths, especially if installing
git-filter-repo using the pip method instead of Scoop, and
particularly with older versions of Git for Windows (anything less
than 2.32.0.windows.1) as GitBash had an unfortunate shebang length
limitation (see [git-for-windows issue
#3165](https://github.com/git-for-windows/git/pull/3165)).

For additional details (if needed, though be aware these might not be
accurate anymore given both git-for-windows and git-filter-repo
fixes), see
[#225](https://github.com/newren/git-filter-repo/pull/225),
[#231](https://github.com/newren/git-filter-repo/pull/231),
[#124](https://github.com/newren/git-filter-repo/issues/124),
[#36](https://github.com/newren/git-filter-repo/issues/36), and [this
git mailing list
thread](https://lore.kernel.org/git/[email protected]/).


# Manual Installation
Expand Down

0 comments on commit 7b09784

Please sign in to comment.