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 <gagbo@users.noreply.github.com>
This commit is contained in:
parent
fe2cb5e705
commit
c1c966c811
6 changed files with 12 additions and 12 deletions
2
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
2
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
6
bin/doom
6
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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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),
|
||||
|
|
|
@ -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"))
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue