From bf9249d002e2e4bd797b76f2140e712399359d3b Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Mon, 25 Nov 2024 20:23:32 -0500 Subject: [PATCH] docs: don't recommend doom/reload Many users seem to treat `doom/reload` like a 1-to-1 replacement for `doom sync` + restart Emacs (which it is not), and are surprised when it fails to properly "reload" their config. I'm considering removing `doom/reload` altogether for this reason, or turning it into a light wrapper around `restart-emacs`, but for now I'll settle for recommending it less in documentation and comments. The references in docs/*.org will be dealt with later. --- lisp/cli/sync.el | 2 +- templates/packages.example.el | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/lisp/cli/sync.el b/lisp/cli/sync.el index e6ed820b2..fc777cd74 100644 --- a/lisp/cli/sync.el +++ b/lisp/cli/sync.el @@ -99,7 +99,7 @@ OPTIONS: (unless noupdate? (doom-packages-update (not update?))) (doom-packages-purge purge? purge? purge? purge? purge?) (when (doom-profile-generate) - (print! (item "Restart Emacs or use 'M-x doom/reload' for changes to take effect")) + (print! (item "Restart Emacs for changes to take effect")) (run-hooks 'doom-after-sync-hook)) (when (or rebuild? (not (file-exists-p doom-cli-sync-info-file))) (with-temp-file doom-cli-sync-info-file diff --git a/templates/packages.example.el b/templates/packages.example.el index 364e6e9b7..9f59d9a67 100644 --- a/templates/packages.example.el +++ b/templates/packages.example.el @@ -2,8 +2,7 @@ ;;; $DOOMDIR/packages.el ;; To install a package with Doom you must declare them here and run 'doom sync' -;; on the command line, then restart Emacs for the changes to take effect -- or -;; use 'M-x doom/reload'. +;; on the command line, then restart Emacs for the changes to take effect. ;; To install SOME-PACKAGE from MELPA, ELPA or emacsmirror: