405f6cdd1e
This setting (along with load-file-rep-suffixes) is simplified at startup to optimize file IO at startup, but it was supposed to be undone at the end of doom-start (in doom-before-init-hook). Unfortunately, the restoration hook was not reaching their top-level bindings, causing dynamic modules (like vterm-modules.so) to fail to load.
101 lines
5 KiB
EmacsLisp
101 lines
5 KiB
EmacsLisp
;;; early-init.el --- Doom's universal bootstrapper -*- lexical-binding: t -*-
|
|
;;; Commentary:
|
|
;;
|
|
;; early-init.el was introduced in Emacs 27.1 and is loaded before init.el, and
|
|
;; before Emacs initializes its UI or package.el, and before site files are
|
|
;; loaded. This is good place for startup optimizating, because only here can
|
|
;; you *prevent* things from loading, rather than turn them off after-the-fact.
|
|
;; As such, Doom does all its initializing here.
|
|
;;
|
|
;; This file is Doom's "universal bootstrapper" for both interactive and
|
|
;; non-interactive sessions. It's also the heart of its profile bootloader,
|
|
;; which allows you to switch between Emacs configs on demand using
|
|
;; `--init-directory DIR' (which was backported from Emacs 29) or `--profile
|
|
;; NAME` (more about profiles at `https://docs.doomemacs.org/-/developers' or
|
|
;; docs/developers.org).
|
|
;;
|
|
;; In summary, this file is responsible for:
|
|
;; - Setting up some universal startup optimizations.
|
|
;; - Determining where `user-emacs-directory' is from one of:
|
|
;; - `--init-directory DIR' (backported from 29)
|
|
;; - `--profile PROFILENAME'
|
|
;; - Do one of the following:
|
|
;; - Load `doom' and one of `doom-start' or `doom-cli'.
|
|
;; - Or (if the user is trying to load a non-Doom config) load
|
|
;; `user-emacs-directory'/early-init.el.
|
|
;;
|
|
;;; Code:
|
|
|
|
;; PERF: Garbage collection is a big contributor to startup times. This fends it
|
|
;; off, but will be reset later by `gcmh-mode'. Not resetting it later will
|
|
;; cause stuttering/freezes.
|
|
(setq gc-cons-threshold most-positive-fixnum)
|
|
|
|
;; PERF: Don't use precious startup time checking mtime on elisp bytecode.
|
|
;; Ensuring correctness is 'doom sync's job, not the interactive session's.
|
|
;; Still, stale byte-code will cause *heavy* losses in startup efficiency.
|
|
(setq load-prefer-newer noninteractive)
|
|
|
|
|
|
;;
|
|
;;; Bootstrap
|
|
|
|
(or
|
|
;; PERF: `file-name-handler-alist' is consulted often. Unsetting it offers a
|
|
;; notable saving in startup time.
|
|
(let (file-name-handler-alist)
|
|
;; FEAT: First, we process --init-directory and --profile to detect what
|
|
;; `user-emacs-directory' to load from. I avoid using
|
|
;; `command-switch-alist' to process --profile and --init-directory because
|
|
;; it is processed too late to change `user-emacs-directory' in time.
|
|
|
|
;; REVIEW: Backported from Emacs 29. Remove when 28 support is dropped.
|
|
(let ((initdir (or (cadr (member "--init-directory" command-line-args))
|
|
(getenv-internal "EMACSDIR"))))
|
|
(when initdir
|
|
;; FIX: Discard the switch to prevent "invalid option" errors later.
|
|
(push (cons "--init-directory" (lambda (_) (pop argv))) command-switch-alist)
|
|
(setq user-emacs-directory (expand-file-name initdir))))
|
|
;; Initialize a known profile, if requested.
|
|
(let ((profile (or (cadr (member "--profile" command-line-args))
|
|
(getenv-internal "DOOMPROFILE"))))
|
|
(when profile
|
|
;; FIX: Discard the switch to prevent "invalid option" errors later.
|
|
(push (cons "--profile" (lambda (_) (pop argv))) command-switch-alist)
|
|
;; Running 'doom sync' will (re)generate a lightweight profile
|
|
;; bootstrapper in $EMACSDIR/profiles/init.el, after reading
|
|
;; $EMACSDIR/profiles.el, $DOOMDIR/profiles,
|
|
;; $XDG_CONFIG_HOME/doom-profiles.el, and ~/.doom-profiles.el. All it
|
|
;; needs is for `$DOOMPROFILE' to be set.
|
|
(setenv "DOOMPROFILE" profile)
|
|
(or (load (expand-file-name (format "profiles/init.%d" emacs-major-version)
|
|
user-emacs-directory)
|
|
'noerror 'nomessage nil t)
|
|
(user-error "Profiles not initialized yet; run 'doom sync' first"))))
|
|
|
|
;; PERF: When `load'ing or `require'ing files, each permutation of
|
|
;; `load-suffixes' and `load-file-rep-suffixes' (then `load-suffixes' +
|
|
;; `load-file-rep-suffixes') is used to locate the file. Each permutation
|
|
;; is a file op, which is normally very fast, but they can add up over the
|
|
;; hundreds/thousands of files Emacs needs to load.
|
|
;;
|
|
;; To reduce that burden -- and since Doom doesn't load any dynamic modules
|
|
;; -- I remove `.so' from `load-suffixes' and pass the `must-suffix' arg to
|
|
;; `load'. See the docs of `load' for details.
|
|
(if (let ((load-suffixes '(".elc" ".el")))
|
|
;; Load the heart of Doom Emacs.
|
|
(load (expand-file-name "lisp/doom" user-emacs-directory)
|
|
'noerror 'nomessage nil 'must-suffix))
|
|
;; ...and prepare for the rest of the session.
|
|
(doom-require (if noninteractive 'doom-cli 'doom-start))
|
|
;; Failing that, assume we're loading a non-Doom config and prepare.
|
|
(setq user-init-file (expand-file-name "early-init" user-emacs-directory)
|
|
;; I make no assumptions about the config we're about to load, so
|
|
;; to limit side-effects, undo any leftover optimizations:
|
|
load-prefer-newer t)
|
|
nil))
|
|
|
|
;; Then continue on to the config/profile we want to load.
|
|
(load early-init-file 'noerror 'nomessage nil 'must-suffix))
|
|
|
|
;;; early-init.el ends here
|