aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2022-12-08 18:00:19 +0100
committerStefan Kangas2022-12-08 18:00:19 +0100
commit5bcd0cee0fc5eba81d254cba91459ba340c71dd3 (patch)
treeaa46441cfa89261a7322015f339274ebc191f253
parent6bb4267a54e1b8e1c02f996a581faca1ed604aab (diff)
downloademacs-feature/use-package.tar.gz
emacs-feature/use-package.zip
* etc/USE-PACKAGE-NEWS: Delete file.feature/use-package
Ref: https://lists.gnu.org/r/emacs-devel/2022-11/msg01535.html
-rw-r--r--etc/USE-PACKAGE-NEWS277
1 files changed, 0 insertions, 277 deletions
diff --git a/etc/USE-PACKAGE-NEWS b/etc/USE-PACKAGE-NEWS
deleted file mode 100644
index c499820755f..00000000000
--- a/etc/USE-PACKAGE-NEWS
+++ /dev/null
@@ -1,277 +0,0 @@
1# Changes
2
3## 2.4.4
4
5This release prepares for inclusion to GNU ELPA and includes no other changes
6
7## 2.4.1
8
9This is mostly a bug-fix release:
10
11- Update the documentation for :custom as per #850
12
13- Fix broken test due to #850
14
15- better tests
16
17- add test for #845
18
19- Support keymap symbol in bind-key. Fix #845
20
21- use-package-core.el: use the Emacs set-default function to avoid saving :custom vars twice
22
23- Fix Travis
24
25- typo, should be a vector, not a bytecode object
26
27 Solves https://github.com/jwiegley/use-package/issues/842
28
29- Add special value back again, in case needed for backwards compat
30
31 I don't know why this special value exists, but perhaps old client code uses it.
32
33 The additional `t' in the macro expansion is accidental but not harmful I guess.
34
35- Even when there's no :config, run any pre/post config hooks
36
37 i.e., following the existing docs for use-package-inject-hooks, these hooks are
38 run:
39
40 use-package--foo--pre-config-hook
41 use-package--foo--post-config-hook
42
43 This should make config customisations more predictable (for example, spacemacs
44 uses these hooks extensively to allow 'layers' to be customised).
45
46 I got rid of the "special" default value for :config, because it doesn't seem to
47 be treated any differently than nil.
48
49 Fixes #785
50
51- Clarify the documentation for :after
52
53- add table of contents to README
54
55- Fix typos
56
57 Typos found with codespell.
58
59- Fix typos
60
61- Attempt to explain omit "-hook" better
62
63- Update tests
64
65- Switch from `require' to `load' + `featurep'
66
67- Use `require', not `load', when byte-compiling
68
69- Make custom-face evaluate elisp.
70
71 Fix #696.
72
73- Add a line of documentation for (use-pacakage ... :hook).
74
75- Fix typo in README
76
77- Fix documentation for defer
78
79- Add no-query option for pdf-tools-install
80
81- Fix typo in README
82
83- Fix all notes in README
84
85- Mention use-package-ensure in README
86
87 Without requiring `use-package-ensure`, setting `use-package-always-ensure`
88 did not actually work for me.
89
90## 2.4
91
92### Breaking changes
93
94- `use-package` no longer requires `diminish` as a dependency, allowing people
95 to decide whether they want to use diminish or delight. This means that if
96 you do use diminish, you'll now need to pull it into your configuration
97 before any use of the `:diminish` kewyord. For example:
98
99 ``` elisp
100 (use-package diminish :ensure t)
101 ```
102
103- Emacs 24.3 or higher is now a requirement.
104
105- The `:defer-install` keyword has been removed. It may reappear as an add-on
106 module for use-package in a future release. See issue #442 for more details.
107
108- There is no longer a `use-package-debug` option, since `use-package-verbose`
109 already has the possible value of `debug`.
110
111- The ordering of several elements of `use-package-keywords` have changed; if
112 you had previously customized this (or were an extension author adding to
113 this list), you may need to rework your changes.
114
115- For extension authors, `:commands` should no longer be propagated down for
116 autoloading. See more below.
117
118### Other changes
119
120- Upgrade license to GPL 3.
121
122- If `use-package-verbose` is set to the symbol `debug`, any evaluation errors
123 during package configuration will cause a complete report to be written to a
124 `*use-package*` buffer, including: the text of the error, the `use-package`
125 declaration that caused the error, the post-normalized form of this
126 declaration, and the macro-expanded version (without verbosity-related
127 code). Note that this still does not help if there are parsing errors, which
128 cause Emacs to register a Lisp error at startup time.
129
130- New customization variable `use-package-deferring-keywords`, mainly intended
131 for use by extension packages, indicates keywords that, if used without
132 `:demand`, cause deferred loading (as if `:defer t` had been specified).
133
134- The `:ensure` keyword now accepts a specific pinning sub-keyword. For
135 example:
136
137 ``` elisp
138 (use-package foo
139 :pin "elpa")
140 ```
141
142 This ensure the package `foo` is installed from `"elpa"`.
143
144 ``` elisp
145 (use-package foo
146 :ensure bar
147 :ensure (quux :pin "melpa"))
148 ```
149
150 This says that `foo` ensures that `bar` is installed, as well as `quux` from
151 `"melpa"`. It does *not* ensure that `foo` is installed, because explicit
152 `:ensure` keywords were given.
153
154- New `:hook` keyword.
155
156- New `:catch` keyword. If `t` or `nil`, it enables (the default, see
157 `use-package-defaults`) or disables catching errors at load time in
158 use-package expansions. It can also be a function taking two arguments: the
159 keyword being processed at the time the error was encountered, and the error
160 object (as generated by `condition-case`).
161
162- New keywords `:custom (foo1 bar1) (foo2 bar2)` etc., and `:custom-face`.
163
164 NOTE: These are only for people who wish to keep customizations with their
165 accompanying use-package declarations. Functionally, the only benefit over
166 using `setq` in a `:config` block is that customizations might execute code
167 when values are assigned. If you currently use `M-x customize-option` and
168 save to a settings file, you do not want to use this option.
169
170- New `:magic` and `:magic-fallback` keywords.
171
172- New `:defer-install` keyword.
173
174- New customization variable `use-package-enable-imenu-support`.
175
176- New customization variable `use-package-hook-name-suffix`. Any symbols named
177 in `:hook`, or in the CAR of cons cells passed to `:hook`, have this text
178 appended to them as a convenience. If you find yourself using this keyword
179 to add to hooks of different names, or just don't want such appending done,
180 you can change the text to an empty string.
181
182- New customization variable `use-package-compute-statistics`, and an
183 accompanying command `M-x use-package-report`. See the README for more
184 details.
185
186- Allow `:diminish` to take no arguments.
187
188- Support multiple symbols passed to `:after`, and a mini-DSL using `:all` and
189 `:any`.
190
191- `:mode` and `:interpreter` can now accept `(rx ...)` forms.
192
193- Using `:load-path` without also using `:ensure` now implies `:ensure nil`.
194
195- `:bind (:map foo-map ...)` now defers binding in the map until the package
196 has been loaded.
197
198- Print key bindings for keymaps in `describe-personal-keybindings`.
199
200- When `use-package-inject-hooks` is non-nil, always fire `:init` and
201 `:config` hooks.
202
203- Documentation added for the `:after`, `:defer-install`, `:delight`,
204 `:requires`, `:when` and `:unless` keywords.
205
206- `:requires SYM` is subtly different from `:if (featurep SYM)`, in that it
207 happens before the `:preface`. This means that using `:requires` will cause
208 definitions in the `:preface` to not be visible to the byte-compiler,
209 leading to possible warnings about unknown functions, or functions that may
210 not be available at run-time (which can generally be ignored, since
211 `:requires` is intended as a check for basic system functionality; `:after`
212 should be used to check for the presence of other modules).
213
214- New undocumented (and currently experimental) keyword `:load` may be used to
215 change the name of the actual package loaded, rather than the package name,
216 and may even add other names. For example: `(use-package auctex :load
217 tex-site)`. This keyword is used internally to generate the `require` for a
218 package, so that deferral is simply a matter of not generating this keyword.
219
220- The source code is now broken into several files, so that certain optional
221 features (diminish, delight, ensure) may be maintained separately from the
222 core functionality.
223
224- When using the `:after` keyword, now even autoloadeds keybinding are
225 deferred until after that other package has loaded, in order to allow
226 convenient `:bind` to maps only present in that other package. Consider the
227 following:
228
229 ``` elisp
230 (use-package helm-descbinds
231 :load-path "site-lisp/helm-descbinds"
232 :after helm
233 :bind ("C-h b" . helm-descbinds)
234 :init
235 (fset 'describe-bindings 'helm-descbinds))
236 ```
237
238 The binding of `C-h b` here will not occur until helm is loaded; and after
239 it is loaded, `helm-descbinds` itself is not loaded until the user presses
240 `C-h b`.
241
242- For extension authors, if you add a keyword to `use-package-keywords` whose
243 presence should indicate deferred loading, please also add it to
244 `use-package-deferring-keywords`. Note that this is a bit of a sledgehammer,
245 in that the mere presence of these keywords implies deferred loading. For a
246 more subtle approach, see the new `use-package-autoloads/<KEYWORD>` support
247 mentioned in the next bullet.
248
249- For extension authors, if you wish deferred loading to possibly occur,
250 create functions named `use-package-autoloads/<KEYWORD>` for each keyword
251 that you define, returning an alist of the form `(SYMBOL . TYPE)` of symbols
252 to be autoloaded. `SYMBOL` should be an interactive function, and `TYPE` the
253 smybol `command`, but this functionality may be extended in future. These
254 autoloads are established if deferred loading is to happen.
255
256- If you specify a lambda form rather than a function symbol in any of the
257 constructs that *might* introduce autoloads: `:bind`, `:bind*`,
258 `:interpreter`, `:mode`, `:magic`, `:magic-fallback`, and `:hook`: then
259 deferred loading will no longer be implied, since there's nothing to
260 associate an autoload with that could later load the module. In these cases,
261 it will be as if you'd specified `:demand t`, in order to ensure the lambda
262 form is able to execute in the context of the loaded package.
263
264- For extension authors, there is a new customization variable
265 `use-package-merge-key-alist` that specifies how values passed to multiple
266 occurrences of the same key should be merged into a single value, during
267 normalization of the `use-package` declaration into a proper plist. The
268 default behavior is to simply append the values together (since they are
269 always normalized to lists).
270
271### Bug fixes
272
273- Repeating a bind no longer causes duplicates in personal-keybindings.
274- When byte-compiling, correctly output declare-function directives.
275- Append to *use-package* when debugging, don't clear it.
276- Don't allow :commands, :bind, etc., to be given an empty list.
277- Explicit :defer t should override use-package-always-demand.