From c1c966c8119e6f6f85ae157e103f0e51d0b000c5 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Sat, 25 Feb 2023 20:29:34 -0500 Subject: [PATCH] docs: assume ~/.config/emacs by default From now on, our documentation will assume your Emacs config lives in ~/.config/emacs, by default, rather than ~/.emacs.d. Support for the latter is not going away, it will simply be mentioned less in the literature, as all supported versions of Emacs going forward (and future versions of Doom) will support (and prefer) XDG conventions. The user manual will be updated separately. Close: #6965 Co-authored-by: gagbo --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- README.md | 6 +++--- bin/doom | 6 +++--- bin/doomscript | 2 +- lisp/cli/install.el | 6 +++--- modules/tools/magit/config.el | 2 +- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d58d196ea..f31efa7e5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -94,7 +94,7 @@ body: attributes: label: System Information description: | - Upload the contents of `M-x doom/info` or `$ ~/.emacs.d/bin/doom info` to [pastebin](https://pastebin.com), [gist](https://gist.github.com), or a similar service, then paste the link to it here. + Upload the contents of `M-x doom/info` or `$ ~/.config/emacs/bin/doom info` to [pastebin](https://pastebin.com), [gist](https://gist.github.com), or a similar service, then paste the link to it here. placeholder: https://pastebin.com/fakeurl validations: required: true diff --git a/README.md b/README.md index 8579b5934..e3a520922 100644 --- a/README.md +++ b/README.md @@ -111,14 +111,14 @@ doctor` to check for any that you may have missed. # Install ``` sh -git clone --depth 1 https://github.com/doomemacs/doomemacs ~/.emacs.d -~/.emacs.d/bin/doom install +git clone --depth 1 https://github.com/doomemacs/doomemacs ~/.config/emacs +~/.config/emacs/bin/doom install ``` Then [read our Getting Started guide][getting-started] to be walked through installing, configuring and maintaining Doom Emacs. -It's a good idea to add `~/.emacs.d/bin` to your `PATH`! Other `bin/doom` +It's a good idea to add `~/.config/emacs/bin` to your `PATH`! Other `bin/doom` commands you should know about: + `doom sync` to synchronize your private config with Doom by installing missing diff --git a/bin/doom b/bin/doom index 5d7f363c4..b2a28fffc 100755 --- a/bin/doom +++ b/bin/doom @@ -89,9 +89,9 @@ (user-error (message "Error: %s" (cadr e)) (kill-emacs 2))) -;; UX: Abort if the user is using 'doom' as root, unless ~/.emacs.d is owned by -;; root, in which case we assume the user genuinely wants root to be their -;; primary user account for Emacs. +;; UX: Abort if the user is using 'doom' as root, unless ~/.config/emacs is +;; owned by root, in which case we assume the user genuinely wants root to be +;; their primary user account for Emacs. (when (equal 0 (user-real-uid)) (unless (equal 0 (file-attribute-user-id (file-attributes doom-emacs-dir))) (message diff --git a/bin/doomscript b/bin/doomscript index cf0d0e13c..6c70a3c63 100755 --- a/bin/doomscript +++ b/bin/doomscript @@ -8,7 +8,7 @@ # For this to work (and to avoid an absolute path in your shebang line), this # file must be in your $PATH: # -# export PATH="$HOME/.emacs.d/bin:$PATH" +# export PATH="$HOME/.config/emacs/bin:$PATH" # # This isn't used for bin/doom because of this $PATH/absolute path requirement # (and using $BASH_SOURCE to locate it would reduce its POSIX compliance), but diff --git a/lisp/cli/install.el b/lisp/cli/install.el index 95a74b13a..e38e5736c 100644 --- a/lisp/cli/install.el +++ b/lisp/cli/install.el @@ -26,9 +26,9 @@ This command does the following: - 1. Creates `$DOOMDIR' at ~/.doom.d, - 2. Copies ~/.emacs.d/templates/init.example.el to `$DOOMDIR'/init.el (if it - doesn't exist), + 1. Creates `$DOOMDIR' at ~/.config/doom (if it or ~/.doom.d doesn't exist), + 2. Copies ~/.config/emacs/templates/init.example.el to `$DOOMDIR'/init.el (if + it doesn't exist), 3. Creates dummy files for `$DOOMDIR'/{config,packages}.el, 4. Prompts you to generate an envvar file (same as `$ doom env`), 5. Installs any dependencies of enabled modules (specified by `$DOOMDIR'/init.el), diff --git a/modules/tools/magit/config.el b/modules/tools/magit/config.el index 80e001cf8..5878ae688 100644 --- a/modules/tools/magit/config.el +++ b/modules/tools/magit/config.el @@ -21,7 +21,7 @@ Only has an effect in GUI Emacs.") :defer-incrementally (dash f s with-editor git-commit package eieio transient) :init (setq magit-auto-revert-mode nil) ; we do this ourselves further down - ;; Must be set early to prevent ~/.emacs.d/transient from being created + ;; Must be set early to prevent ~/.config/emacs/transient from being created (setq transient-levels-file (concat doom-data-dir "transient/levels") transient-values-file (concat doom-data-dir "transient/values") transient-history-file (concat doom-data-dir "transient/history"))