summaryrefslogtreecommitdiff
path: root/lisp/image.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-09-28 22:03:27 +0300
committerEli Zaretskii <eliz@gnu.org>2022-09-28 22:03:27 +0300
commitcf38e1c3939f4799113755c762fc7b8c3093fe56 (patch)
treeabbcea2214b9457a2317435a3d7d64d67f8d94ee /lisp/image.el
parentfc212364ce8f4615f27c2de40a2815ce2a8d95b2 (diff)
downloademacs-cf38e1c3939f4799113755c762fc7b8c3093fe56.tar.gz
Clarify image file search
* doc/lispref/display.texi (Defining Images, Image Descriptors): * lisp/image.el (create-image): Clarify that non-absolute image files are searched along 'image-load-path'. (Bug#52931)
Diffstat (limited to 'lisp/image.el')
-rw-r--r--lisp/image.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/image.el b/lisp/image.el
index ea1a22698c6..72b7862c957 100644
--- a/lisp/image.el
+++ b/lisp/image.el
@@ -460,8 +460,9 @@ must be available."
;;;###autoload
(defun create-image (file-or-data &optional type data-p &rest props)
- "Create an image.
-FILE-OR-DATA is an image file name or image data.
+ "Create an image from FILE-OR-DATA.
+FILE-OR-DATA is an image file name or image data. If it is a relative
+file name, the function will look for it along `image-load-path'.
Optional TYPE is a symbol describing the image type. If TYPE is omitted
or nil, try to determine the image type from its first few bytes