Skip to content

Commit fd64b0c

Browse files
committed
INSTALL.md: more clarifications and links
Someone was surprised by my claim that someone else had reported Microsoft provided a stub or stripped down python. Link to where it was reported in case others hit the same problem. Vilius Šumskas reported that the need to edit the shebang line has been corrected with the newest Git for Windows, so update the text to note this. It's possible other users may still have problems given the variety of Windows versions and the number of reports I had about this, so I want to still leave links there for at least a little while. Be more explicit about how pip is lame and provides virtually no benefit since it leaves you to fix your $PATH yourself, which was the only step that was needed in installing the whole package anyway. Signed-off-by: Elijah Newren <[email protected]>
1 parent a557077 commit fd64b0c

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

INSTALL.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,24 @@ these versions.
2020
# Notes for Windows Users
2121

2222
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
23+
of Python (it has been reported that Windows ships with a [stub or
24+
stripped down python-like program that just doesn't
25+
work](https://github.com/newren/git-filter-repo/issues/36#issuecomment-568933825)).
26+
python.org probably has good instructions here, though many users
27+
report a preference getting it from the [Microsoft
2728
Store](https://docs.microsoft.com/en-us/windows/python/beginners) and
2829
seem to be successful with that (particularly since [msys2 issue
2930
#27](https://github.com/msys2/msys2-runtime/pull/27) was fixed by the
3031
Git for Windows maintainer).
3132

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
33+
In the past, several users also needed to modify the first line of the
34+
git-filter-repo script to change the python path, particularly when
35+
installing git-filter-repo using the pip method instead of Scoop, and
3536
particularly with older versions of Git for Windows (anything less
3637
than 2.32.0.windows.1) as GitBash had an unfortunate shebang length
3738
limitation (see [git-for-windows issue
38-
#3165](https://github.com/git-for-windows/git/pull/3165)).
39+
#3165](https://github.com/git-for-windows/git/pull/3165)). Hopefully,
40+
this isn't needed anymore.
3941

4042
For additional details (if needed, though be aware these might not be
4143
accurate anymore given both git-for-windows and git-filter-repo
@@ -124,16 +126,19 @@ So, installation might look something like the following:
124126

125127
# Installation via [pip](https://pip.pypa.io/)
126128

127-
For those who prefer to install python packages via pip, you merely need
128-
to run:
129+
This method is NOT recommended, because [installing via pip does not
130+
place the package in your
131+
$PATH](https://stackoverflow.com/questions/35898734/pip-installs-packages-successfully-but-executables-not-found-from-command-line).
132+
If you go this route, you have to copy the file into an appropriate
133+
directory (either `git --exec-path` or something else in $PATH), or
134+
modify your $PATH to include the directory where pip places things,
135+
but you could have just done that after cloning filter-repo directly
136+
so this installation method provides virtually no benefit.
129137

130-
$ pip3 install git-filter-repo
138+
However, some people still prefer installing this way. If you are
139+
one of them, you can use:
131140

132-
However, the place where pip places that package might not be in your
133-
$PATH (thus requiring you to manually update your $PATH afterwards),
134-
and on windows the pip install might not take care of python-specific
135-
issues for you (see "Notes for Windows Users", above). As such,
136-
installation via package managers is recommended instead.
141+
$ pip3 install git-filter-repo
137142

138143

139144
# Installation via Makefile

0 commit comments

Comments
 (0)