From: John Wiegley <johnw@newartisans.com>
Date: Wed, 6 Dec 2017 14:22:52 +0000 (-0800)
Subject: Clarify :config with setq versus :custom
X-Git-Tag: emacs-29.0.90~1306^2~15^2~122
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0939993935603a7ad171e1a86083ef3afe210919;p=emacs.git

Clarify :config with setq versus :custom

Fixes https://github.com/jwiegley/use-package/issues/564
---

diff --git a/etc/USE-PACKAGE-NEWS b/etc/USE-PACKAGE-NEWS
index b959a7578e7..1cc64d12342 100644
--- a/etc/USE-PACKAGE-NEWS
+++ b/etc/USE-PACKAGE-NEWS
@@ -80,6 +80,12 @@
 
 - New keywords `:custom (foo1 bar1) (foo2 bar2)` etc., and `:custom-face`.
 
+  NOTE: These are only for people who wish to keep customizations with their
+  accompanying use-package declarations. Functionally, the only benefit over
+  using `setq` in a `:config` block is that customizations might execute code
+  when values are assigned. If you currently use `M-x customize-option` and
+  save to a settings file, you do not want to use this option.
+
 - New `:magic` and `:magic-fallback` keywords.
 
 - New `:defer-install` keyword.