Skip to content

Commit

Permalink
runtime(doc): clarify directory of Vim's executable vs CWD
Browse files Browse the repository at this point in the history
According to :h win32-PATH, "the same directory as Vim" means the same
directory as the Vim executable, not Vim's current directory.  In patch
8.2.4860 these two concepts were mixed up.

closes: vim#15451

Signed-off-by: zeertzjq <[email protected]>
Signed-off-by: Christian Brabandt <[email protected]>
  • Loading branch information
zeertzjq authored and chrisbra committed Aug 8, 2024
1 parent 6b97d7a commit 0cc5dce
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions runtime/doc/builtin.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*builtin.txt* For Vim version 9.1. Last change: 2024 Jul 28
*builtin.txt* For Vim version 9.1. Last change: 2024 Aug 08


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -2532,8 +2532,10 @@ executable({expr}) *executable()*
This function checks if an executable with the name {expr}
exists. {expr} must be the name of the program without any
arguments.

executable() uses the value of $PATH and/or the normal
searchpath for programs. *PATHEXT*
searchpath for programs.
*PATHEXT*
On MS-Windows the ".exe", ".bat", etc. can optionally be
included. Then the extensions in $PATHEXT are tried. Thus if
"foo.exe" does not exist, "foo.exe.bat" can be found. If
Expand All @@ -2543,11 +2545,14 @@ executable({expr}) *executable()*
then the name is also tried without adding an extension.
On MS-Windows it only checks if the file exists and is not a
directory, not if it's really executable.
On MS-Windows an executable in the same directory as Vim is
normally found. Since this directory is added to $PATH it
should also work to execute it |win32-PATH|. This can be
disabled by setting the $NoDefaultCurrentDirectoryInExePath
environment variable. *NoDefaultCurrentDirectoryInExePath*
On MS-Windows an executable in the same directory as the Vim
executable is always found. Since this directory is added to
$PATH it should also work to execute it |win32-PATH|.
*NoDefaultCurrentDirectoryInExePath*
On MS-Windows an executable in Vim's current working directory
is also normally found, but this can be disabled by setting
the $NoDefaultCurrentDirectoryInExePath environment variable.

The result is a Number:
1 exists
0 does not exist
Expand Down

0 comments on commit 0cc5dce

Please sign in to comment.