emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: add fish shell check

Browse source
This commit is contained in:
Henrik Lissner 2023-09-12 02:31:44 +02:00
parent 447b59c9c0
commit 69cedebfda
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
lisp/cli/doctor.el
View file

@ -160,6 +160,23 @@ in."
doom-dir) doom-dir)
(explain! "The second directory will be ignored, as it has lower precedence.")))) (explain! "The second directory will be ignored, as it has lower precedence."))))
(print! (start "Checking for common environmental issues..."))
(when (string-match-p "/fish$" shell-file-name)
(print! (warn "Detected Fish as your $SHELL"))
(explain! "Fish (and possibly other non-POSIX shells) is known to inject garbage "
"output into some of the child processes that Emacs spawns. Many Emacs "
"packages/utilities will choke on this output, causing unpredictable issues. "
"To get around this, either:\n\n"
" - Add the following to $DOOMDIR/config.el:\n\n"
" (setq shell-file-name (executable-find \"bash\"))\n\n"
" - Or change your default shell to a POSIX shell (like bash or zsh) "
" and explicitly configure your terminal apps to use the shell you "
" want.\n\n"
"If you opt for option 1 and use one of Emacs' terminal emulators, you "
"will also need to configure them to use Fish, e.g.\n\n"
" (setq-default vterm-shell (executable-find \"fish\"))\n\n"
" (setq-default explicit-shell-file-name (executable-find \"fish\"))\n"))
(print! (start "Checking for stale elc files...")) (print! (start "Checking for stale elc files..."))
(elc-check-dir doom-core-dir) (elc-check-dir doom-core-dir)
(elc-check-dir doom-modules-dir) (elc-check-dir doom-modules-dir)