Doom profiles documentation: run doom env --profile

AlessandroW commented 1 month ago

I confirm that...

[X] I have searched the issue tracker, documentation, FAQ, Discourse, and Google, in case this issue has already been reported/resolved.
[X] I have read "How to Debug Issues", and will use it to provide as much information about this issue as possible.
[X] The issue can be reproduced on the latest available commit of Doom.
[X] The issue can be reproduced on a stable release of Emacs, such as 27, 28, or 29. (Unstable versions end in .50, .60, or .9x)

Expected behavior

After going through the documentation I expected that profiles work.

Current behavior

Weird things happen, e.g., magit complains that there is no emacsclient.

Steps to reproduce

Follow: https://github.com/doomemacs/doomemacs/tree/master/profiles/

Create a profile in ~/.config/doom-profiles.el:

;; -*- mode: emacs-lisp; -*-
((default (user-emacs-directory . "~/.emacs.d")
          (doom-user-dir . "~/.config/doom/default/"))))

To solve this, simply run: doom env --profile default. This should be documented (if it is the correct thing to do).

System Information

https://pastebin.com/KLdY39pR

hlissner commented 2 weeks ago

I'm not quite sure I understand the problem here. Are you expecting the default profile to be the same as the "global" profile? If so, see this section of the docs, there is no such thing as a "default" or "fallback" profile -- there are no magical profile names -- so it is necessary to specify the profile when running doom env if you want to update the envvar file for a specific profile.

AlessandroW commented 2 weeks ago

Maybe calling the profile default in the Issue was misleading..

No, my point was that after moving from a default config to a two-profile config, I had to run doom env for each profile otherwise strange things happened (env related, I assume), e.g., magit complained about a missing emacsclient. I didn't see it in the docs, hence this issue.

doomemacs / doomemacs