Improve windows-related docs and notes #1640
Merged
+9
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an attempt to improve some of the Windows-related documentation as well as comments in some related files.
The main user-visible bit is a suggestion to change the man page which currently mentions:
AFAIU, unlike for non-Windows [1], on Windows, there is no default value baked in to
janet.exe
[2].The proposed new text is:
Note that, if one installs from the official (or locally-built)
.msi
, "arrangements are made" (TM) so thatJANET_PATH
is set to some location under%APPDATA%
[3]. Thus, subsequent typical invocations ofjanet.exe
(e.g. those made via new command prompts) will haveJANET_PATH
set and consequently(dyn :syspath)
will likely yield a non-nil string path.While I was at it, I also tweaked the man page bit about
JANET_PATH
to have:[1] See here and here.
[2] This was also verified by manually building
janet.exe
from source on Windows and checking(dyn :syspath)
(which returnednil
) on a system that didn't have Janet installed via a typical.msi
.[3] A comment was added to
tools/msi/janet.wxs
to this effect.