2022-07-30 19:49:00 +00:00
|
|
|
;;; doom.el --- the heart of the beast -*- lexical-binding: t; -*-
|
2022-06-18 13:04:12 +00:00
|
|
|
;;
|
|
|
|
|
;; Author: Henrik Lissner <contact@henrik.io>
|
|
|
|
|
;; URL: https://github.com/doomemacs/doomemacs
|
|
|
|
|
;;
|
|
|
|
|
;; ================= =============== =============== ======== ========
|
|
|
|
|
;; \\ . . . . . . .\\ //. . . . . . .\\ //. . . . . . .\\ \\. . .\\// . . //
|
|
|
|
|
;; ||. . ._____. . .|| ||. . ._____. . .|| ||. . ._____. . .|| || . . .\/ . . .||
|
|
|
|
|
;; || . .|| ||. . || || . .|| ||. . || || . .|| ||. . || ||. . . . . . . ||
|
|
|
|
|
;; ||. . || || . .|| ||. . || || . .|| ||. . || || . .|| || . | . . . . .||
|
|
|
|
|
;; || . .|| ||. _-|| ||-_ .|| ||. . || || . .|| ||. _-|| ||-_.|\ . . . . ||
|
|
|
|
|
;; ||. . || ||-' || || `-|| || . .|| ||. . || ||-' || || `|\_ . .|. .||
|
|
|
|
|
;; || . _|| || || || || ||_ . || || . _|| || || || |\ `-_/| . ||
|
|
|
|
|
;; ||_-' || .|/ || || \|. || `-_|| ||_-' || .|/ || || | \ / |-_.||
|
|
|
|
|
;; || ||_-' || || `-_|| || || ||_-' || || | \ / | `||
|
|
|
|
|
;; || `' || || `' || || `' || || | \ / | ||
|
|
|
|
|
;; || .===' `===. .==='.`===. .===' /==. | \/ | ||
|
|
|
|
|
;; || .==' \_|-_ `===. .===' _|_ `===. .===' _-|/ `== \/ | ||
|
|
|
|
|
;; || .==' _-' `-_ `=' _-' `-_ `=' _-' `-_ /| \/ | ||
|
|
|
|
|
;; || .==' _-' '-__\._-' '-_./__-' `' |. /| | ||
|
|
|
|
|
;; ||.==' _-' `' | /==.||
|
|
|
|
|
;; ==' _-' \/ `==
|
|
|
|
|
;; \ _-' `-_ /
|
|
|
|
|
;; `'' ``'
|
|
|
|
|
;;
|
|
|
|
|
;; These demons are not part of GNU Emacs.
|
|
|
|
|
;;
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
;;
|
|
|
|
|
;; This is Doom's heart, where I define all its major constants and variables,
|
|
|
|
|
;; set its saner global defaults, then prepare Emacs to bootstrap Doom.
|
|
|
|
|
;;
|
|
|
|
|
;; The overall load order of Doom is as follows:
|
|
|
|
|
;;
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
;; > $EMACSDIR/early-init.el
|
|
|
|
|
;; > $EMACSDIR/lisp/doom.el
|
|
|
|
|
;; - $EMACSDIR/lisp/doom-lib.el
|
|
|
|
|
;; > $EMACSDIR/lisp/doom-start.el
|
|
|
|
|
;; - hook: `doom-before-init-hook'
|
|
|
|
|
;; - $DOOMDIR/init.el
|
fix: add :depth field to modules
This introduces a depth field for modules so that they may dictate their
load order explicitly, it also treats depths <= -100 or >= 100 as
special depths, which will be loaded early, before their respective
doom-{before,after}-module-{init,config}-hook. This permits psuedo
modules like :core and :user modules to be treated as normal modules
without too many special cases.
This also fixes a module load order issue on Emacs 29 (#6813), caused by
emacs-mirror/emacs@4311bd0bd73c, which changed the return value order of
hash-table-{keys,values} causing modules to be loaded in reverse order;
resulting in the loss of evil keybinds, among other things.
Other notable changes:
- Changes the data structure for module data caches from a list to a
vector. Uses less memory and permits faster lookups. Also adds two
depth fields to the front of it.
- Changes the signature of doom-module-list and doom-package-list.
- Renames doom--read-packages -> doom-packages--read for consistency
with naming convention.
- Add doom-module-depth function.
- Adds a temporary doom-core-dir/init.el file, which is responsible for
loading doom-*.el.
Fix: #6813
Ref: emacs-mirror/emacs@4311bd0bd73c
2022-09-23 16:55:20 +00:00
|
|
|
;; > $XDG_DATA_HOME/doom/$PROFILE/@/$VERSION/init.el (replaces $EMACSDIR/init.el)
|
|
|
|
|
;; - $EMACSDIR/doom-{keybinds,ui,projects,editor}.el
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
;; - hook: `doom-before-modules-init-hook'
|
|
|
|
|
;; - {$DOOMDIR,$EMACSDIR}/modules/*/*/init.el
|
|
|
|
|
;; - hook: `doom-after-modules-init-hook'
|
|
|
|
|
;; - hook: `doom-before-modules-config-hook'
|
|
|
|
|
;; - {$DOOMDIR,$EMACSDIR}/modules/*/*/config.el
|
|
|
|
|
;; - hook: `doom-after-modules-config-hook'
|
|
|
|
|
;; - $DOOMDIR/config.el
|
|
|
|
|
;; - `custom-file' or $DOOMDIR/custom.el
|
|
|
|
|
;; > The rest of `command-line' (Emacs startup)
|
|
|
|
|
;; - hook: `after-init-hook'
|
|
|
|
|
;; - hook: `emacs-startup-hook'
|
|
|
|
|
;; - hook: `window-setup-hook'
|
|
|
|
|
;; - hook: `doom-init-ui-hook'
|
|
|
|
|
;; - hook: `doom-after-init-hook'
|
|
|
|
|
;; > After startup is complete:
|
|
|
|
|
;; - On first input: `doom-first-input-hook'
|
|
|
|
|
;; - On first switched-to buffer: `doom-first-buffer-hook'
|
|
|
|
|
;; - On first opened file: `doom-first-file-hook'
|
|
|
|
|
;;
|
|
|
|
|
;; This is Doom's heart, where I define all its major constants and variables,
|
|
|
|
|
;; set only its sanest global defaults, employ its hackiest (and least
|
|
|
|
|
;; offensive) optimizations, and load the minimum for all Doom sessions.
|
2022-06-18 13:04:12 +00:00
|
|
|
;;
|
|
|
|
|
;;; Code:
|
2022-09-15 21:41:02 +00:00
|
|
|
(eval-when-compile (require 'subr-x))
|
2017-01-17 04:15:48 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Version checks
|
2022-09-13 16:00:34 +00:00
|
|
|
(eval-and-compile ; Check version at both compile and runtime.
|
|
|
|
|
;; Doom's minimum supported version of Emacs is 27.1. Its my goal to support
|
|
|
|
|
;; one major version below the stable release, for about a year or until
|
|
|
|
|
;; stable is ubiquitous (or at least easily accessible) across Linux distros.
|
|
|
|
|
(when (< emacs-major-version 27)
|
|
|
|
|
(user-error
|
|
|
|
|
(concat
|
2022-09-15 21:28:01 +00:00
|
|
|
"Detected Emacs " emacs-version ", but Doom requires 27.1 or newer (28.1 is\n\n"
|
|
|
|
|
"recommended). The current Emacs executable in use is:\n\n " (car command-line-args)
|
|
|
|
|
"\n\nA guide for installing a newer version of Emacs can be found at:\n\n "
|
2022-09-13 16:00:34 +00:00
|
|
|
(format "https://docs.doomemacs.org/-/install/%s"
|
|
|
|
|
(cond ((eq system-type 'darwin) "on-macos")
|
|
|
|
|
((memq system-type '(cygwin windows-nt ms-dos)) "on-windows")
|
|
|
|
|
("on-linux")))
|
|
|
|
|
"\n\n"
|
2022-09-15 21:28:01 +00:00
|
|
|
(if noninteractive
|
|
|
|
|
(concat "Alternatively, either update your $PATH environment variable to include the\n"
|
|
|
|
|
"path of the desired Emacs executable OR alter the $EMACS environment variable\n"
|
|
|
|
|
"to specify the exact path or command needed to invoke Emacs."
|
|
|
|
|
(when-let (command (ignore-errors (file-name-nondirectory (cadr (member "--load" command-line-args)))))
|
|
|
|
|
(concat " For example:\n\n"
|
|
|
|
|
" $ EMACS=/path/to/valid/emacs " command " ...\n"
|
|
|
|
|
" $ EMACS=\"/Applications/Emacs.app/Contents/MacOS/Emacs\" " command " ...\n"
|
|
|
|
|
" $ EMACS=\"snap run emacs\" " command " ..."))
|
|
|
|
|
"\n\nAborting...")
|
|
|
|
|
(concat "If you believe this error is a mistake, run 'doom doctor' on the command line\n"
|
|
|
|
|
"to diagnose common issues with your config and system."))))))
|
2022-09-06 20:28:52 +00:00
|
|
|
|
|
|
|
|
;; Doom needs to be synced/rebuilt if either Doom or Emacs has been
|
|
|
|
|
;; up/downgraded. This is because byte-code isn't backwards compatible, and many
|
|
|
|
|
;; packages (including Doom), make in absolute paths into their caches that need
|
|
|
|
|
;; to be refreshed.
|
|
|
|
|
(let ((old-version (eval-when-compile emacs-version)))
|
|
|
|
|
(unless (equal emacs-version old-version)
|
|
|
|
|
(user-error (concat "Doom was compiled with Emacs %s, but was loaded with %s. Run 'doom sync' to"
|
|
|
|
|
"recompile it.")
|
|
|
|
|
emacs-version old-version)))
|
2021-10-09 17:31:21 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Custom features
|
|
|
|
|
;; Since `system-configuration-features's docs state not to rely on it to test
|
|
|
|
|
;; for features, let's give users an easier way to detect them.
|
|
|
|
|
(if (bound-and-true-p module-file-suffix)
|
|
|
|
|
(push 'dynamic-modules features))
|
|
|
|
|
(if (fboundp #'json-parse-string)
|
|
|
|
|
(push 'jansson features))
|
|
|
|
|
;; `native-compile' exists whether or not it is functional (e.g. libgcc is
|
|
|
|
|
;; available or not). This seems silly, so pretend it doesn't exist if it
|
|
|
|
|
;; isn't available.
|
|
|
|
|
(if (featurep 'native-compile)
|
|
|
|
|
(if (not (native-comp-available-p))
|
|
|
|
|
(delq 'native-compile features)))
|
|
|
|
|
|
|
|
|
|
;;; Global constants
|
|
|
|
|
;; DEPRECATED remove in v3
|
|
|
|
|
(defconst IS-MAC (eq system-type 'darwin))
|
|
|
|
|
(defconst IS-LINUX (memq system-type '(gnu gnu/linux gnu/kfreebsd berkeley-unix)))
|
|
|
|
|
(defconst IS-WINDOWS (memq system-type '(cygwin windows-nt ms-dos)))
|
|
|
|
|
(defconst IS-BSD (memq system-type '(darwin berkeley-unix gnu/kfreebsd)))
|
|
|
|
|
(defconst EMACS28+ (> emacs-major-version 27))
|
|
|
|
|
(defconst EMACS29+ (> emacs-major-version 28))
|
|
|
|
|
(defconst MODULES (featurep 'dynamic-modules))
|
|
|
|
|
(defconst NATIVECOMP (featurep 'native-compile))
|
2022-09-13 11:08:37 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
(make-obsolete-variable 'EMACS28+ "Use (>= emacs-major-version 28) instead" "3.0.0")
|
|
|
|
|
(make-obsolete-variable 'EMACS29+ "Use (>= emacs-major-version 29) instead" "3.0.0")
|
|
|
|
|
(make-obsolete-variable 'MODULES "Use (featurep 'dynamic-modules) instead" "3.0.0")
|
|
|
|
|
(make-obsolete-variable 'NATIVECOMP "Use (featurep 'native-compile) instead" "3.0.0")
|
2022-09-13 12:06:56 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Fix $HOME on Windows
|
|
|
|
|
;; $HOME isn't normally defined on Windows, but many unix tools expect it.
|
|
|
|
|
(when IS-WINDOWS
|
|
|
|
|
(when-let (realhome
|
|
|
|
|
(and (null (getenv-internal "HOME"))
|
|
|
|
|
(getenv "USERPROFILE")))
|
|
|
|
|
(setenv "HOME" realhome)
|
|
|
|
|
(setq abbreviated-home-dir nil)))
|
2022-09-13 12:06:56 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Load Doom's stdlib
|
|
|
|
|
(add-to-list 'load-path (file-name-directory load-file-name))
|
|
|
|
|
(require 'doom-lib)
|
2022-06-18 13:04:12 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
;;
|
2022-09-13 11:08:37 +00:00
|
|
|
;;; Core globals
|
|
|
|
|
|
|
|
|
|
(defgroup doom nil
|
|
|
|
|
"An Emacs framework for the stubborn martian hacker."
|
|
|
|
|
:link '(url-link "https://doomemacs.org"))
|
|
|
|
|
|
2022-09-15 01:19:48 +00:00
|
|
|
(defconst doom-version "3.0.0-pre"
|
2022-09-13 11:08:37 +00:00
|
|
|
"Current version of Doom Emacs core.")
|
|
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;; DEPRECATED: Remove these when the modules are moved out of core.
|
2022-09-15 01:19:48 +00:00
|
|
|
(defconst doom-modules-version "22.09.0-pre"
|
2022-09-13 11:08:37 +00:00
|
|
|
"Current version of Doom Emacs.")
|
|
|
|
|
|
|
|
|
|
(defconst doom-profile
|
|
|
|
|
(if-let (profile (getenv-internal "DOOMPROFILE"))
|
2022-09-14 15:57:03 +00:00
|
|
|
(save-match-data
|
|
|
|
|
(if (string-match "^\\([^@]+\\)@\\(.+\\)$" profile)
|
|
|
|
|
(cons (match-string 1 profile)
|
|
|
|
|
(match-string 2 profile))
|
|
|
|
|
(cons profile "0")))
|
|
|
|
|
;; TODO Restore this in 3.0
|
|
|
|
|
;; (cons "_" "0")
|
2022-09-13 11:08:37 +00:00
|
|
|
)
|
2022-09-14 15:57:03 +00:00
|
|
|
"The active profile as a cons cell (NAME . VERSION).")
|
2022-09-13 11:08:37 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Data directory variables
|
2022-09-17 18:10:03 +00:00
|
|
|
(defvar doom-emacs-dir user-emacs-directory
|
2022-09-13 11:08:37 +00:00
|
|
|
"The path to the currently loaded .emacs.d directory. Must end with a slash.")
|
|
|
|
|
|
|
|
|
|
(defconst doom-core-dir (file-name-directory load-file-name)
|
|
|
|
|
"The root directory of Doom's core files. Must end with a slash.")
|
|
|
|
|
|
2022-09-17 18:10:03 +00:00
|
|
|
(defvar doom-modules-dir (expand-file-name "modules/" doom-emacs-dir)
|
2019-05-01 23:12:52 +00:00
|
|
|
"The root directory for Doom's modules. Must end with a slash.")
|
2018-02-16 07:02:58 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
(define-obsolete-variable-alias 'doom-private-dir 'doom-user-dir "3.0.0")
|
2022-09-17 18:10:03 +00:00
|
|
|
(defvar doom-user-dir
|
2022-09-13 12:06:56 +00:00
|
|
|
(expand-file-name
|
|
|
|
|
(if-let (doomdir (getenv-internal "DOOMDIR"))
|
|
|
|
|
(file-name-as-directory doomdir)
|
|
|
|
|
(or (let ((xdgdir
|
|
|
|
|
(file-name-concat
|
|
|
|
|
(or (getenv-internal "XDG_CONFIG_HOME")
|
|
|
|
|
"~/.config")
|
|
|
|
|
"doom/")))
|
|
|
|
|
(if (file-directory-p xdgdir) xdgdir))
|
|
|
|
|
"~/.doom.d/")))
|
2022-07-27 20:25:08 +00:00
|
|
|
"Where your private configuration is placed.
|
|
|
|
|
|
|
|
|
|
Defaults to ~/.config/doom, ~/.doom.d or the value of the DOOMDIR envvar;
|
|
|
|
|
whichever is found first. Must end in a slash.")
|
|
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
;; DEPRECATED: .local will be removed entirely in 3.0
|
|
|
|
|
(defvar doom-local-dir
|
2021-10-09 17:31:21 +00:00
|
|
|
(if-let (localdir (getenv-internal "DOOMLOCALDIR"))
|
|
|
|
|
(expand-file-name (file-name-as-directory localdir))
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
(expand-file-name ".local/" doom-emacs-dir))
|
2019-05-01 23:12:52 +00:00
|
|
|
"Root directory for local storage.
|
|
|
|
|
|
|
|
|
|
Use this as a storage location for this system's installation of Doom Emacs.
|
2020-10-11 20:22:57 +00:00
|
|
|
|
2019-05-01 23:12:52 +00:00
|
|
|
These files should not be shared across systems. By default, it is used by
|
2022-08-14 16:10:01 +00:00
|
|
|
`doom-data-dir' and `doom-cache-dir'. Must end with a slash.")
|
2017-03-17 03:38:22 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
(define-obsolete-variable-alias 'doom-etc-dir 'doom-data-dir "3.0.0")
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
(defvar doom-data-dir
|
2022-07-27 20:25:08 +00:00
|
|
|
(if doom-profile
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
(if IS-WINDOWS
|
|
|
|
|
(expand-file-name "doomemacs/data/" (getenv-internal "APPDATA"))
|
|
|
|
|
(expand-file-name "doom/" (or (getenv-internal "XDG_DATA_HOME") "~/.local/share")))
|
|
|
|
|
;; DEPRECATED: .local will be removed entirely in 3.0
|
2022-09-17 09:00:08 +00:00
|
|
|
(file-name-concat doom-local-dir "etc/"))
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
"Where Doom stores its global data files.
|
|
|
|
|
|
|
|
|
|
Data files contain shared and long-lived data that Doom, Emacs, and their
|
|
|
|
|
packages require to function correctly or at all. Deleting them by hand will
|
|
|
|
|
cause breakage, and require user intervention (e.g. a 'doom sync' or 'doom env')
|
|
|
|
|
to restore.
|
2017-12-22 19:48:07 +00:00
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
Use this for: server binaries, package source, pulled module libraries,
|
|
|
|
|
generated files for profiles, profiles themselves, autoloads/loaddefs, etc.
|
2017-06-11 21:50:50 +00:00
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
For profile-local data files, use `doom-profile-data-dir' instead.")
|
|
|
|
|
|
|
|
|
|
(defvar doom-cache-dir
|
2022-07-27 20:25:08 +00:00
|
|
|
(if doom-profile
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
(if IS-WINDOWS
|
|
|
|
|
(expand-file-name "doomemacs/cache/" (getenv-internal "APPDATA"))
|
|
|
|
|
(expand-file-name "doom/" (or (getenv-internal "XDG_CACHE_HOME") "~/.cache")))
|
|
|
|
|
;; DEPRECATED: .local will be removed entirely in 3.0
|
2022-09-17 09:00:08 +00:00
|
|
|
(file-name-concat doom-local-dir "cache/"))
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
"Where Doom stores its global cache files.
|
|
|
|
|
|
|
|
|
|
Cache files represent non-essential data that shouldn't be problematic when
|
|
|
|
|
deleted (besides, perhaps, a one-time performance hit), lack portability (and so
|
|
|
|
|
shouldn't be copied to other systems/configs), and are regenerated when needed,
|
|
|
|
|
without user input (e.g. a 'doom sync').
|
2017-01-17 04:15:48 +00:00
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
Some examples: images/data caches, elisp bytecode, natively compiled elisp,
|
|
|
|
|
session files, ELPA archives, authinfo files, org-persist, etc.
|
2017-04-17 00:36:15 +00:00
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
For profile-local cache files, use `doom-profile-cache-dir' instead.")
|
|
|
|
|
|
|
|
|
|
(defvar doom-state-dir
|
2022-07-27 20:25:08 +00:00
|
|
|
(if doom-profile
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
(if IS-WINDOWS
|
|
|
|
|
(expand-file-name "doomemacs/state/" (getenv-internal "APPDATA"))
|
|
|
|
|
(expand-file-name "doom/" (or (getenv-internal "XDG_STATE_HOME") "~/.local/state")))
|
|
|
|
|
;; DEPRECATED: .local will be removed entirely in 3.0
|
2022-09-17 09:00:08 +00:00
|
|
|
(file-name-concat doom-local-dir "state/"))
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
"Where Doom stores its global state files.
|
|
|
|
|
|
|
|
|
|
State files contain non-essential, unportable, but persistent data which, if
|
|
|
|
|
lost won't cause breakage, but may be inconvenient as they cannot be
|
|
|
|
|
automatically regenerated or restored. For example, a recently-opened file list
|
|
|
|
|
is not essential, but losing it means losing this record, and restoring it
|
|
|
|
|
requires revisiting all those files.
|
|
|
|
|
|
|
|
|
|
Use this for: history, logs, user-saved data, autosaves/backup files, known
|
|
|
|
|
projects, recent files, bookmarks.
|
2019-05-01 23:12:52 +00:00
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
For profile-local state files, use `doom-profile-state-dir' instead.")
|
2018-06-11 21:18:15 +00:00
|
|
|
|
refactor!: complete profile gen and init systems
BREAKING CHANGE: This commit makes three breaking changes:
- Doom now fully and dynamically generates (and byte-compiles) your
profile and its init files, which includes your autoloads, loading
your init files and modules, and then some. This replaces
doom-initialize-modules, doom-initialize-core-modules, and
doom-module-loader, which have been removed. This has also improved
startup time by a bit, but if you use these functions in your CLIs,
for instance, this will be a breaking change.
- `doom sync` is now required for Doom to see your profiles (and must be
run whenever you change them, or when you up/downgrade Emacs across
major versions).
- $DOOMDIR/init.el is now read much earlier than it used to be. Before
any of doom-{ui,keybinds,editor,projects}, before any autoloads are
loaded, and before your load-path has been populated with your
packages. It now runs in the context of early-init.el, giving users
freer range over what they can affect, but a more minimalistic
environment to do it in.
If you must have some logic run when all that is set up, add it to one
of the module hooks added in e08f68b or 283308a.
This also poses a significant change to Doom's load order (see the
commentary change in lib/doom.el), along with the following (non
breaking) changes:
1. Adds a new `doom profiles sync` command. This will forcibly resync
your profiles, while `doom sync` will only do so if your profiles
have changed.
2. Doom now fully and dynamically generates (and byte-compiles) your
user-init-file, which includes loading all your init files, modules,
and custom-file. This replaces the job of doom-initialize-modules,
doom-initialize-core-modules, and doom-module-loader, which have been
removed. This has also improved startup time by a bit.
3. Defines new doom-state-dir variable, though not used yet (saving that
and the other breaking changes for the 3.0 release).
4. Redesigns profile directory variables (doom-profile-*-dir) to prepare
for future XDG-compliance.
5. Removed unused/unimportant profile variables in doom.el.
6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's
enough to power the system as it is now.
7. Updates the "load order" commentary in doom.el to reflect these
changes.
2022-09-15 16:53:06 +00:00
|
|
|
;;; Profile file/directory variables
|
|
|
|
|
(defvar doom-profile-cache-dir
|
|
|
|
|
(file-name-concat doom-cache-dir (car doom-profile))
|
|
|
|
|
"For profile-local cache files under `doom-cache-dir'.")
|
|
|
|
|
|
|
|
|
|
(defvar doom-profile-data-dir
|
|
|
|
|
(file-name-concat doom-data-dir (car doom-profile))
|
|
|
|
|
"For profile-local data files under `doom-data-dir'.")
|
|
|
|
|
|
|
|
|
|
(defvar doom-profile-state-dir
|
|
|
|
|
(file-name-concat doom-state-dir (car doom-profile))
|
|
|
|
|
"For profile-local state files under `doom-state-dir'.")
|
|
|
|
|
|
|
|
|
|
(defconst doom-profile-dir
|
|
|
|
|
(file-name-concat doom-profile-data-dir "@" (cdr doom-profile))
|
|
|
|
|
"Where generated files for the active profile are kept.")
|
|
|
|
|
|
|
|
|
|
;; DEPRECATED: Will be moved to cli/env
|
2022-07-27 20:25:08 +00:00
|
|
|
(defconst doom-env-file
|
2022-09-13 12:06:56 +00:00
|
|
|
(file-name-concat (if doom-profile
|
|
|
|
|
doom-profile-dir
|
|
|
|
|
doom-local-dir)
|
|
|
|
|
"env")
|
2020-02-20 04:34:16 +00:00
|
|
|
"The location of your envvar file, generated by `doom env`.
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 04:06:10 +00:00
|
|
|
|
2019-05-01 23:12:52 +00:00
|
|
|
This file contains environment variables scraped from your shell environment,
|
|
|
|
|
which is loaded at startup (if it exists). This is helpful if Emacs can't
|
2019-05-03 01:54:47 +00:00
|
|
|
\(easily) be launched from the correct shell session (particularly for MacOS
|
2019-05-01 23:12:52 +00:00
|
|
|
users).")
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 04:06:10 +00:00
|
|
|
|
2020-12-02 00:33:55 +00:00
|
|
|
|
2022-08-13 19:27:11 +00:00
|
|
|
;;
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Startup optimizations
|
2022-08-13 19:27:11 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;; Here are Doom's hackiest (and least offensive) startup optimizations. They
|
2022-09-15 21:47:34 +00:00
|
|
|
;; exploit implementation details and unintended side-effects, and will change
|
|
|
|
|
;; often between major Emacs releases. However, I disable them if this is a
|
|
|
|
|
;; daemon session (where startup time matters less) or in debug-mode (to
|
|
|
|
|
;; mitigate interference with our debugging).
|
2022-09-14 15:57:03 +00:00
|
|
|
(unless (or (daemonp) init-file-debug)
|
|
|
|
|
;; PERF: `file-name-handler-alist' is consulted on each call to `require',
|
|
|
|
|
;; `load', or various file/io functions (like `expand-file-name' or
|
|
|
|
|
;; `file-remote-p'). You get a noteable boost to startup time by unsetting
|
|
|
|
|
;; or simplifying its value.
|
2022-09-14 17:01:57 +00:00
|
|
|
(let ((old-value (default-toplevel-value 'file-name-handler-alist)))
|
2022-09-14 15:57:03 +00:00
|
|
|
(setq file-name-handler-alist
|
|
|
|
|
;; HACK: If the bundled elisp for this Emacs install isn't
|
|
|
|
|
;; byte-compiled (but is compressed), then leave the gzip file
|
|
|
|
|
;; handler there so Emacs won't forget how to read read them.
|
|
|
|
|
;;
|
|
|
|
|
;; calc-loaddefs.el is our heuristic for this because it is built-in
|
|
|
|
|
;; to all supported versions of Emacs, and calc.el explicitly loads
|
|
|
|
|
;; it uncompiled. This ensures that the only other, possible
|
|
|
|
|
;; fallback would be calc-loaddefs.el.gz.
|
|
|
|
|
(if (eval-when-compile
|
|
|
|
|
(locate-file-internal "calc-loaddefs.el" load-path))
|
|
|
|
|
nil
|
|
|
|
|
(list (rassq 'jka-compr-handler old-value))))
|
|
|
|
|
;; Make sure the new value survives any current let-binding.
|
|
|
|
|
(set-default-toplevel-value 'file-name-handler-alist file-name-handler-alist)
|
|
|
|
|
;; COMPAT: ...but restore `file-name-handler-alist' later, because it is
|
|
|
|
|
;; needed for handling encrypted or compressed files, among other things.
|
|
|
|
|
(add-hook! 'emacs-startup-hook :depth 101
|
|
|
|
|
(defun doom--reset-file-handler-alist-h ()
|
|
|
|
|
(setq file-name-handler-alist
|
|
|
|
|
;; Merge instead of overwrite because there may have been changes to
|
|
|
|
|
;; `file-name-handler-alist' since startup we want to preserve.
|
|
|
|
|
(delete-dups (append file-name-handler-alist old-value))))))
|
2022-08-13 19:27:11 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
(unless noninteractive
|
|
|
|
|
;; PERF: Resizing the Emacs frame (to accommodate fonts that are smaller or
|
|
|
|
|
;; larger than the system font) appears to impact startup time
|
|
|
|
|
;; dramatically. The larger the delta in font size, the greater the delay.
|
|
|
|
|
;; Even trivial deltas can yield a ~1000ms loss, though it varies wildly
|
|
|
|
|
;; depending on font size.
|
|
|
|
|
(setq frame-inhibit-implied-resize t)
|
2022-08-13 19:27:11 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;; PERF,UX: Reduce *Message* noise at startup. An empty scratch buffer (or
|
|
|
|
|
;; the dashboard) is more than enough, and faster to display.
|
|
|
|
|
(setq inhibit-startup-screen t
|
|
|
|
|
inhibit-startup-echo-area-message user-login-name)
|
|
|
|
|
;; PERF,UX: Remove "For information about GNU Emacs..." message at startup.
|
|
|
|
|
;; It's redundant with our dashboard and incurs a premature redraw.
|
|
|
|
|
(advice-add #'display-startup-echo-area-message :override #'ignore)
|
2016-05-26 22:51:39 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;; PERF: Shave seconds off startup time by starting the scratch buffer in
|
|
|
|
|
;; `fundamental-mode', rather than, say, `org-mode' or `text-mode', which
|
|
|
|
|
;; pull in a ton of packages. `doom/open-scratch-buffer' provides a better
|
|
|
|
|
;; scratch buffer anyway.
|
|
|
|
|
(setq initial-major-mode 'fundamental-mode
|
|
|
|
|
initial-scratch-message nil)
|
|
|
|
|
|
|
|
|
|
;; PERF: Inexplicably, `tty-run-terminal-initialization' can sometimes take
|
|
|
|
|
;; 2-3s when starting up Emacs in the terminal. Whatever slows it down at
|
|
|
|
|
;; startup doesn't appear to affect it if it's called a little later in
|
|
|
|
|
;; the startup process, so that's what I do.
|
2022-09-15 21:47:34 +00:00
|
|
|
;; REVIEW: This optimization is not well understood. Investigate it!
|
2022-09-15 21:43:49 +00:00
|
|
|
(unless initial-window-system
|
|
|
|
|
(advice-add #'tty-run-terminal-initialization :override #'ignore)
|
|
|
|
|
(add-hook! 'window-setup-hook
|
|
|
|
|
(defun doom--reset-tty-run-terminal-initialization-h ()
|
|
|
|
|
(advice-remove #'tty-run-terminal-initialization #'ignore)
|
|
|
|
|
(tty-run-terminal-initialization (selected-frame) nil t))))
|
2022-09-14 15:57:03 +00:00
|
|
|
|
|
|
|
|
;; PERF,UX: Site files tend to use `load-file', which emits "Loading X..."
|
|
|
|
|
;; messages in the echo area. Writing to the echo-area triggers a
|
|
|
|
|
;; redisplay, which can be expensive during startup. This may also cause
|
|
|
|
|
;; an flash of white when creating the first frame.
|
|
|
|
|
(define-advice load-file (:override (file) silence)
|
|
|
|
|
(load file nil 'nomessage))
|
|
|
|
|
;; COMPAT: But undo our `load-file' advice later, as to limit the scope of
|
|
|
|
|
;; any edge cases it could induce.
|
|
|
|
|
(define-advice startup--load-user-init-file (:before (&rest _) undo-silence)
|
|
|
|
|
(advice-remove #'load-file #'load-file@silence))
|
|
|
|
|
|
|
|
|
|
;; PERF: `load-suffixes' and `load-file-rep-suffixes' are consulted on each
|
|
|
|
|
;; `require' and `load'. Doom won't load any dmodules this early, so omit
|
|
|
|
|
;; .so for a small startup boost. This is later restored in doom-start.
|
2022-09-14 17:01:57 +00:00
|
|
|
(put 'load-suffixes 'initial-value (default-toplevel-value 'load-suffixes))
|
|
|
|
|
(put 'load-file-rep-suffixes 'initial-value (default-toplevel-value 'load-file-rep-suffixes))
|
2022-09-14 15:57:03 +00:00
|
|
|
(set-default-toplevel-value 'load-suffixes '(".elc" ".el"))
|
|
|
|
|
(set-default-toplevel-value 'load-file-rep-suffixes '(""))
|
2022-09-14 17:01:57 +00:00
|
|
|
;; COMPAT: Undo any problematic startup optimizations; from this point, I make
|
|
|
|
|
;; no assumptions about what might be loaded in userland.
|
|
|
|
|
(add-hook! 'doom-before-init-hook
|
|
|
|
|
(defun doom--reset-load-suffixes-h ()
|
|
|
|
|
(setq load-suffixes (get 'load-suffixes 'initial-value)
|
|
|
|
|
load-file-rep-suffixes (get 'load-file-rep-suffixes 'initial-value))))
|
2022-09-14 15:57:03 +00:00
|
|
|
|
|
|
|
|
;; PERF: The mode-line procs a couple dozen times during startup. This is
|
|
|
|
|
;; normally quite fast, but disabling the default mode-line and reducing the
|
|
|
|
|
;; update delay timer seems to stave off ~30-50ms.
|
2022-09-14 17:01:57 +00:00
|
|
|
(put 'mode-line-format 'initial-value (default-toplevel-value 'mode-line-format))
|
2022-09-14 15:57:03 +00:00
|
|
|
(setq-default mode-line-format nil)
|
|
|
|
|
(dolist (buf (buffer-list))
|
|
|
|
|
(with-current-buffer buf (setq mode-line-format nil)))
|
|
|
|
|
;; PERF,UX: Premature redisplays can substantially affect startup times and
|
|
|
|
|
;; produce ugly flashes of unstyled Emacs.
|
|
|
|
|
(setq-default inhibit-redisplay t
|
|
|
|
|
inhibit-message t)
|
|
|
|
|
;; COMPAT: Then reset it with advice, because `startup--load-user-init-file'
|
|
|
|
|
;; will never be interrupted by errors. And if these settings are left
|
|
|
|
|
;; set, Emacs could appear frozen or garbled.
|
|
|
|
|
(define-advice startup--load-user-init-file (:after (&rest _) undo-inhibit-vars)
|
|
|
|
|
(setq-default inhibit-redisplay nil
|
|
|
|
|
inhibit-message nil)
|
|
|
|
|
(unless (default-toplevel-value 'mode-line-format)
|
|
|
|
|
(setq-default mode-line-format (get 'mode-line-format 'initial-value))))
|
|
|
|
|
|
2022-09-15 19:47:17 +00:00
|
|
|
;; PERF: Doom disables the UI elements by default, so that there's less for
|
|
|
|
|
;; the frame to initialize. However, the toolbar is still populated
|
|
|
|
|
;; regardless, so I lazy load it until tool-bar-mode is actually used.
|
|
|
|
|
(advice-add #'tool-bar-setup :override #'ignore)
|
|
|
|
|
(define-advice startup--load-user-init-file (:before (&rest _) defer-tool-bar-setup)
|
|
|
|
|
(advice-remove #'tool-bar-setup #'ignore)
|
|
|
|
|
(add-transient-hook! 'tool-bar-mode (tool-bar-setup)))
|
|
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;; PERF: Unset a non-trivial list of command line options that aren't
|
|
|
|
|
;; relevant to our current OS, but `command-line-1' still processes.
|
|
|
|
|
(unless IS-MAC
|
|
|
|
|
(setq command-line-ns-option-alist nil))
|
|
|
|
|
(when (or IS-MAC IS-WINDOWS)
|
|
|
|
|
(setq command-line-x-option-alist nil))))
|
fix: memory leak & freezes on native-comp+pgtk builds
b7f84bd introduced a nasty regression that caused an infinite loop and
runaway memory usage on some pgtk+native-comp builds of Emacs when it
attempted to perform deferred native compilation of your packages. This
would make Emacs unusable and, if left alone, could even crash your
system.
The only Emacs builds I'm certain are affected are derived from
flatwhatson/emacs (like emacs-pgtk-native-comp on Guix and Arch Linux in
particular). 28.1 stable and master (on emacs-mirror/emacs@e13509468b7c)
are unaffected.
It appears that some, earlier pgtk builds stack idle timers differently.
I'm not entirely sure how, because it doesn't manifest in more recent
builds of Emacs, and I'm already burnt out on debugging this, but here's
how Doom encountered it:
Doom has an incremental package loader; it loads packages, piecemeal,
after Emacs has been idle for 2s, then again every 0.75s until it
finishes or the user sends input (then it waits another 2s before
starting again). However, if at any time the iloader detected that
native-compilation is in progress, it waits 2s before trying
again (repeat, until native-comp is done). But here's the catch, given
the following:
(run-with-idle-timer
2 nil (lambda ()
(run-with-idle-timer 1 nil (lambda () (message "hi")))))
I had assumed "hi" would be emitted after 3 seconds (once idle), but
instead it is emitted after 2. Like this, Doom's iloader would elapse
one idle timer directly into another, ad infinitum, until Emacs was
forcibly killed.
By switching to run-at-time and employing my own rudimentary idle timer,
I avoid this issue. Also, the iloader no longer needs to be considerate
of native-comp, because the latter does its own rate-limiting controlled
by native-comp-async-jobs-number.
Amend: b7f84bdd0105
2022-09-09 23:01:28 +00:00
|
|
|
|
2020-12-02 00:33:55 +00:00
|
|
|
|
|
|
|
|
|
2020-12-01 18:43:51 +00:00
|
|
|
;;
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Reasonable, global defaults
|
2020-12-01 18:43:51 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Don't litter `doom-emacs-dir'/$HOME
|
2022-09-12 16:05:14 +00:00
|
|
|
;; HACK: I change `user-emacs-directory' because many packages (even built-in
|
|
|
|
|
;; ones) abuse it to build paths for storage/cache files (instead of correctly
|
|
|
|
|
;; using `locate-user-emacs-file'). This change ensures that said data files
|
|
|
|
|
;; are never saved to the root of your emacs directory *and* saves us the
|
2022-09-13 16:19:56 +00:00
|
|
|
;; trouble of setting a million directory/file variables. But it may throw off
|
|
|
|
|
;; anyone (or any package) that uses it to search for your Emacs initfiles.
|
2022-09-17 18:12:06 +00:00
|
|
|
(setq user-emacs-directory doom-profile-cache-dir)
|
2022-06-17 22:37:46 +00:00
|
|
|
|
|
|
|
|
;; ...However, this may surprise packages (and users) that read
|
|
|
|
|
;; `user-emacs-directory' expecting to find the location of your Emacs config,
|
|
|
|
|
;; such as server.el!
|
2022-09-13 12:06:56 +00:00
|
|
|
(setq server-auth-dir (file-name-concat doom-emacs-dir "server/"))
|
2022-06-17 22:37:46 +00:00
|
|
|
|
|
|
|
|
;; Packages with file/dir settings that don't use `user-emacs-directory' or
|
|
|
|
|
;; `locate-user-emacs-file' to initialize will need to set explicitly, to stop
|
|
|
|
|
;; them from littering in ~/.emacs.d/.
|
2022-09-17 18:12:06 +00:00
|
|
|
(setq desktop-dirname (file-name-concat doom-profile-state-dir "desktop")
|
|
|
|
|
pcache-directory (file-name-concat doom-profile-cache-dir "pcache/"))
|
2022-06-17 22:37:46 +00:00
|
|
|
|
|
|
|
|
;; Allow the user to store custom.el-saved settings and themes in their Doom
|
|
|
|
|
;; config (e.g. ~/.doom.d/).
|
2022-09-13 12:06:56 +00:00
|
|
|
(setq custom-file (file-name-concat doom-user-dir "custom.el"))
|
2022-06-17 22:37:46 +00:00
|
|
|
|
2022-07-29 10:22:33 +00:00
|
|
|
;; By default, Emacs stores `authinfo' in $HOME and in plain-text. Let's not do
|
|
|
|
|
;; that, mkay? This file stores usernames, passwords, and other treasures for
|
|
|
|
|
;; the aspiring malicious third party. You'll need a GPG setup though.
|
2022-09-17 18:12:06 +00:00
|
|
|
(setq auth-sources (list (file-name-concat doom-profile-state-dir "authinfo.gpg")
|
2022-07-29 10:22:33 +00:00
|
|
|
"~/.authinfo.gpg"))
|
|
|
|
|
|
2022-06-17 22:37:46 +00:00
|
|
|
(define-advice en/disable-command (:around (fn &rest args) write-to-data-dir)
|
2022-09-12 16:05:14 +00:00
|
|
|
"Save safe-local-variables to `custom-file' instead of `user-init-file'.
|
2022-06-17 22:37:46 +00:00
|
|
|
|
|
|
|
|
Otherwise, `en/disable-command' (in novice.el.gz) is hardcoded to write them to
|
|
|
|
|
`user-init-file')."
|
|
|
|
|
(let ((user-init-file custom-file))
|
2021-08-04 05:18:06 +00:00
|
|
|
(apply fn args)))
|
2020-06-13 20:09:26 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;;; Native compilation support (see http://akrl.sdf.org/gccemacs.html)
|
|
|
|
|
(when (boundp 'native-comp-eln-load-path)
|
|
|
|
|
;; Don't store eln files in ~/.emacs.d/eln-cache (where they can easily be
|
|
|
|
|
;; deleted by 'doom upgrade').
|
|
|
|
|
;; REVIEW Use `startup-redirect-eln-cache' when 28 support is dropped
|
2022-09-17 18:12:06 +00:00
|
|
|
(add-to-list 'native-comp-eln-load-path (expand-file-name "eln/" doom-profile-cache-dir))
|
2020-08-18 01:46:54 +00:00
|
|
|
|
2022-09-14 15:57:03 +00:00
|
|
|
;; UX: Suppress compiler warnings and don't inundate users with their popups.
|
|
|
|
|
;; They are rarely more than warnings, so are safe to ignore.
|
|
|
|
|
(setq native-comp-async-report-warnings-errors init-file-debug
|
2022-09-16 17:06:15 +00:00
|
|
|
native-comp-warning-on-missing-source init-file-debug)
|
|
|
|
|
|
|
|
|
|
;; UX: By default, native-comp uses 100% of half your cores. If you're
|
|
|
|
|
;; expecting this this should be no issue, but the sudden (and silent) spike
|
|
|
|
|
;; of CPU and memory utilization can alarm folks, overheat laptops, or
|
|
|
|
|
;; overwhelm less performant systems.
|
|
|
|
|
(define-advice comp-effective-async-max-jobs (:before (&rest _) set-default-cpus)
|
|
|
|
|
"Default to 1/4 of cores in interactive sessions and all of them otherwise."
|
|
|
|
|
(and (null comp-num-cpus)
|
|
|
|
|
(zerop native-comp-async-jobs-number)
|
|
|
|
|
(setq comp-num-cpus
|
|
|
|
|
(max 1 (/ (num-processors) (if noninteractive 1 4)))))))
|
2022-09-14 15:57:03 +00:00
|
|
|
|
|
|
|
|
;;; Suppress package.el
|
|
|
|
|
;; Since Emacs 27, package initialization occurs before `user-init-file' is
|
|
|
|
|
;; loaded, but after `early-init-file'. Doom handles package initialization, so
|
|
|
|
|
;; we must prevent Emacs from doing it again.
|
|
|
|
|
(setq package-enable-at-startup nil)
|
2022-06-18 13:04:12 +00:00
|
|
|
|
2022-09-13 16:19:56 +00:00
|
|
|
;;; Reduce unnecessary/unactionable warnings/logs
|
2022-06-18 13:04:12 +00:00
|
|
|
;; Disable warnings from the legacy advice API. They aren't actionable or
|
|
|
|
|
;; useful, and often come from third party packages.
|
2021-10-09 17:31:21 +00:00
|
|
|
(setq ad-redefinition-action 'accept)
|
2018-06-15 12:58:31 +00:00
|
|
|
|
2022-08-08 15:51:29 +00:00
|
|
|
;; Ignore warnings about "existing variables being aliased". Otherwise the user
|
|
|
|
|
;; gets very intrusive popup warnings about our (intentional) uses of
|
2022-09-11 22:42:15 +00:00
|
|
|
;; defvaralias, which are done because ensuring aliases are created before
|
|
|
|
|
;; packages are loaded is an unneeded and unhelpful maintenance burden. Emacs
|
|
|
|
|
;; still aliases them fine regardless.
|
|
|
|
|
(with-eval-after-load 'warnings
|
2022-08-08 15:51:29 +00:00
|
|
|
(add-to-list 'warning-suppress-types '(defvaralias)))
|
|
|
|
|
|
2022-06-18 13:04:12 +00:00
|
|
|
;; Reduce debug output unless we've asked for it.
|
2021-10-09 17:31:21 +00:00
|
|
|
(setq debug-on-error init-file-debug
|
|
|
|
|
jka-compr-verbose init-file-debug)
|
2020-08-02 20:28:56 +00:00
|
|
|
|
2022-09-13 16:19:56 +00:00
|
|
|
;;; Stricter security defaults
|
2022-06-18 13:04:12 +00:00
|
|
|
;; Emacs is essentially one huge security vulnerability, what with all the
|
|
|
|
|
;; dependencies it pulls in from all corners of the globe. Let's try to be a
|
|
|
|
|
;; *little* more discerning.
|
|
|
|
|
(setq gnutls-verify-error noninteractive
|
|
|
|
|
gnutls-algorithm-priority
|
|
|
|
|
(when (boundp 'libgnutls-version)
|
|
|
|
|
(concat "SECURE128:+SECURE192:-VERS-ALL"
|
|
|
|
|
(if (and (not IS-WINDOWS)
|
|
|
|
|
(>= libgnutls-version 30605))
|
|
|
|
|
":+VERS-TLS1.3")
|
|
|
|
|
":+VERS-TLS1.2"))
|
|
|
|
|
;; `gnutls-min-prime-bits' is set based on recommendations from
|
|
|
|
|
;; https://www.keylength.com/en/4/
|
|
|
|
|
gnutls-min-prime-bits 3072
|
|
|
|
|
tls-checktrust gnutls-verify-error
|
|
|
|
|
;; Emacs is built with gnutls.el by default, so `tls-program' won't
|
|
|
|
|
;; typically be used, but in the odd case that it does, we ensure a more
|
|
|
|
|
;; secure default for it (falling back to `openssl' if absolutely
|
|
|
|
|
;; necessary). See https://redd.it/8sykl1 for details.
|
|
|
|
|
tls-program '("openssl s_client -connect %h:%p -CAfile %t -nbio -no_ssl3 -no_tls1 -no_tls1_1 -ign_eof"
|
|
|
|
|
"gnutls-cli -p %p --dh-bits=3072 --ocsp --x509cafile=%t \
|
|
|
|
|
--strict-tofu --priority='SECURE192:+SECURE128:-VERS-ALL:+VERS-TLS1.2:+VERS-TLS1.3' %h"
|
|
|
|
|
;; compatibility fallbacks
|
|
|
|
|
"gnutls-cli -p %p %h"))
|
2017-06-08 09:47:56 +00:00
|
|
|
|
2022-09-14 17:01:57 +00:00
|
|
|
|
|
|
|
|
;;
|
|
|
|
|
;;; Custom hooks
|
|
|
|
|
|
|
|
|
|
(defcustom doom-before-init-hook ()
|
|
|
|
|
"A hook run before Doom has been initialized and before $DOOMDIR/init.el.
|
|
|
|
|
|
|
|
|
|
This occurs in the context of early-init.el. Much of Emacs and Doom isn't
|
|
|
|
|
initialized at this point, only loaded. Use this for configuration at the latest
|
|
|
|
|
opportunity before the session becomes unpredictably complicated by user config,
|
|
|
|
|
packages, etc.
|
|
|
|
|
|
|
|
|
|
Do not use this for interactive functionality, as it's triggered in
|
|
|
|
|
noninteractive sessions as well, after Doom core has been loaded, but not
|
|
|
|
|
initialized.
|
|
|
|
|
|
|
|
|
|
In contrast, `before-init-hook' is run just after $DOOMDIR/init.el is loaded,
|
|
|
|
|
but before the rest of Doom is loaded."
|
|
|
|
|
:group 'doom
|
|
|
|
|
:type 'hook)
|
|
|
|
|
|
|
|
|
|
(defcustom doom-after-init-hook ()
|
|
|
|
|
"A hook run at the (true) end of Emacs startup.
|
|
|
|
|
|
|
|
|
|
When this runs, all modules, config files, and startup hooks have been
|
|
|
|
|
triggered. This is the absolute latest point in the startup process."
|
|
|
|
|
:group 'doom
|
|
|
|
|
:type 'hook)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;
|
|
|
|
|
;;; Last minute initialization
|
|
|
|
|
|
|
|
|
|
(add-hook! 'doom-before-init-hook
|
|
|
|
|
(defun doom--set-initial-values-h ()
|
|
|
|
|
;; Remember these variables' initial values, so we can safely reset them at
|
|
|
|
|
;; a later time, or consult them without fear of contamination.
|
|
|
|
|
(dolist (var '(exec-path load-path process-environment))
|
|
|
|
|
(put var 'initial-value (default-toplevel-value var)))))
|
|
|
|
|
|
|
|
|
|
;; This is the absolute latest a hook can run in Emacs' startup process.
|
|
|
|
|
(define-advice command-line-1 (:after (&rest _) run-after-init-hook)
|
|
|
|
|
(doom-run-hooks 'doom-after-init-hook))
|
|
|
|
|
|
2022-07-30 19:49:00 +00:00
|
|
|
(provide 'doom)
|
|
|
|
|
;;; doom.el ends here
|