procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document incompatible overlay priority change

Browse source 
* doc/lispref/display.texi (Overlay Properties): Update re priority. 

* etc/NEWS: Related edit.

Fixes: debbugs:17234
This commit is contained in:
Glenn Morris 2014-06-05 23:45:16 -07:00
parent 9f7c9816f6
commit 137dcb47fb
3 changed files with 20 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/lispref/ChangeLog
View file

@ -1,3 +1,7 @@
2014-06-06 Glenn Morris <rgm@gnu.org>
* display.texi (Overlay Properties): Update re priority. (Bug#17234)
2014-06-05 Glenn Morris <rgm@gnu.org>
* package.texi (Package Archives): Mention signing packages.

16
doc/lispref/display.texi
View file

@ -1515,9 +1515,9 @@ of them:
@table @code
@item priority
@kindex priority @r{(overlay property)}
This property's value determines the priority of the overlay. No priority, or
@code{nil}, means zero. A non-nil and non-integer value has
undefined behavior.
This property's value determines the priority of the overlay.
If you want to specify a priority value, use either @code{nil}
(or zero), or a positive integer. Any other value has undefined behavior.
The priority matters when two or more overlays cover the same
character and both specify the same property; the one whose
@ -1527,9 +1527,13 @@ completely override the other value; instead, its face attributes
override the face attributes of the lower priority @code{face}
property.
Currently, all overlays take priority over text properties. Please
avoid using negative priority values, as we have not yet decided just
what they should mean.
Currently, all overlays take priority over text properties.
Note that Emacs sometimes uses non-numeric priority values for some of
its internal overlays, so do not try to do arithmetic on the
priority of an overlay (unless it is one that you created). If you
need to put overlays in priority order, use the @var{sorted} argument
of @code{overlays-at}. @xref{Finding Overlays}.
@item window
@kindex window @r{(overlay property)}

8
etc/NEWS
View file

@ -1149,6 +1149,12 @@ low-level libraries gfilenotify.c, inotify.c or w32notify.c.
* Incompatible Lisp Changes in Emacs 24.4
+++
** Do not assume that the priority of all overlays will be numeric.
(You should still only specify integer priorities on overlays you create.)
If you need to sort arbitrary overlays into priority order, `overlays-at'
can now optionally do this.
---
** `kill-region' has lost its `yank-handler' optional argument.
@ -1248,8 +1254,6 @@ the other.
* Lisp Changes in Emacs 24.4
** overlays-at can optionally sort its result by priority.
+++
** The second argument of `eval' can now specify a lexical environment.