summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2017-12-05 13:33:11 -0800
committerJohn Wiegley <johnw@newartisans.com>2017-12-05 13:33:11 -0800
commitb5a0cd4f30798a535b4a71241ed86e3c2b22fb4a (patch)
treec0f883e23835f7c7af4dfdf02899b0b263712c9d
parentb25a305c588744b51276d2c4245d0a268f4d42f9 (diff)
downloademacs-b5a0cd4f30.tar.gz
Add note in NEWS.md about :requires vs. :if
-rw-r--r--etc/USE-PACKAGE-NEWS8
1 files changed, 8 insertions, 0 deletions
diff --git a/etc/USE-PACKAGE-NEWS b/etc/USE-PACKAGE-NEWS
index 5873d699089..b959a7578e7 100644
--- a/etc/USE-PACKAGE-NEWS
+++ b/etc/USE-PACKAGE-NEWS
@@ -108,6 +108,14 @@
- Documentation added for the `:after`, `:defer-install`, `:delight`,
`:requires`, `:when` and `:unless` keywords.
+- `:requires SYM` is subtly different from `:if (featurep SYM)`, in that it
+ happens before the `:preface`. This means that using `:requires` will cause
+ definitions in the `:preface` to not be visible to the byte-compiler,
+ leading to possible warnings about unknown functions, or functions that may
+ not be available at run-time (which can generally be ignored, since
+ `:requires` is intended as a check for basic system functionality; `:after`
+ should be used to check for the presence of other modules).
+
- New undocumented (and currently experimental) keyword `:load` may be used to
change the name of the actual package loaded, rather than the package name,
and may even add other names. For example: `(use-package auctex :load