m-vim_plugins/vim-gitgutter
1
0
Fork 0
mirror of https://github.com/airblade/vim-gitgutter.git synced 2025-11-08 19:43:47 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add caveat to setting of Windows git executable

Browse Source 
See #668.
This commit is contained in:
Andy Stewart
2021-06-08 16:29:34 +01:00
parent 68a8cb300c
commit 0f98634b92
2 changed files with 15 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.mkd
View File

@@ -77,13 +77,16 @@ nvim -u NONE -c "helptags vim-gitgutter/doc" -c q
### Windows ### Windows
I recommend configuring vim-gitgutter with the full path to your git executable. For example: There is a potential risk on Windows due to `cmd.exe` prioritising the current folder over folders in `PATH`. If you have a file named `git.*` (i.e. with any extension in `PATHEXT`) in your current folder, it will be executed instead of git whenever the plugin calls git.
You can avoid this risk by configuring the full path to your git executable. For example:
```viml ```viml
" This path probably won't work
let g:gitgutter_git_executable = 'C:\Program Files\Git\bin\git.exe' let g:gitgutter_git_executable = 'C:\Program Files\Git\bin\git.exe'
``` ```
This is to avoid a problem which occurs if you have file named `git.*` (i.e. with any extension in `PATHEXT`) in your current folder. `cmd.exe` prioritises the current folder over folders in `PATH` and will try to execute your file instead of the `git` binary. Unfortunately I don't know the correct escaping for the path - if you do, please let me know!
### Getting started ### Getting started

15
doc/gitgutter.txt
View File

@@ -63,15 +63,20 @@ Neovim:~
=============================================================================== ===============================================================================
WINDOWS *gitgutter-windows* WINDOWS *gitgutter-windows*
I recommend configuring vim-gitgutter with the full path to your git executable. There is a potential risk on Windows due to `cmd.exe` prioritising the current
folder over folders in `PATH`. If you have a file named `git.*` (i.e. with
any extension in `PATHEXT`) in your current folder, it will be executed
instead of git whenever the plugin calls git.
You can avoid this risk by configuring the full path to your git executable.
For example: For example:
> >
" This path probably won't work
let g:gitgutter_git_executable = 'C:\Program Files\Git\bin\git.exe' let g:gitgutter_git_executable = 'C:\Program Files\Git\bin\git.exe'
< <
This is to avoid a problem which occurs if you have file named "git.*" (i.e.
with any extension in "PATHEXT") in your current folder. "cmd.exe" prioritises Unfortunately I don't know the correct escaping for the path - if you do,
the current folder over folders in 'PATH' and will try to execute your file please let me know!
instead of the "git" binary.
=============================================================================== ===============================================================================