]> git.eshelyaron.com Git - emacs.git/commitdiff
Mention image caching in the `image-size' doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 21 Sep 2019 08:16:10 +0000 (10:16 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 21 Sep 2019 08:16:10 +0000 (10:16 +0200)
* src/image.c (Fimage_size): Mention that this function caches
images, and what to do about that (bug#33275).

src/image.c

index fe7bd90b051e3f0624832de506613c5d842817bb..5183558029ce8261e988c72c53bf9153fb1c2d8e 100644 (file)
@@ -1050,8 +1050,13 @@ DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
        doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
 PIXELS non-nil means return the size in pixels, otherwise return the
 size in canonical character units.
+
 FRAME is the frame on which the image will be displayed.  FRAME nil
-or omitted means use the selected frame.  */)
+or omitted means use the selected frame.
+
+Calling this function will result in the image being stored in the
+image cache.  If this is not desirable, call `image-flush' after
+calling this function.  */)
   (Lisp_Object spec, Lisp_Object pixels, Lisp_Object frame)
 {
   Lisp_Object size;