branch: elpa/exec-path-from-shell
commit c2ca275d3243e8253513ced73e3ac21dc352e303
Author: Steve Purcell <[email protected]>
Commit: Steve Purcell <[email protected]>
Clarify incompatibility with cmdproxy.exe et al
Thanks @bbatsov
---
README.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f08b6cef3c..30ac00994a 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,11 @@ variables of interest, then copying them into the Emacs
environment.
Compatibility
-------------
-If you use a non-POSIX-standard shell such as `tcsh` or `fish`, your
+At a minimum, this package assumes that your shell is at least UNIX-y: if
+`(getenv "SHELL")` evaluates to something like `".../cmdproxy.exe"`, this
+package probably isn't for you.
+
+Further, if you use a non-POSIX-standard shell such as `tcsh` or `fish`, your
shell will be asked to execute `sh` as a subshell in order to print
out the variables in a format which can be reliably parsed. `sh` must
be a POSIX-compliant shell in this case.
