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

Clarify image file search

Browse source 
* 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)
This commit is contained in:
Eli Zaretskii 2022-09-28 22:03:27 +03:00
parent fc212364ce
commit cf38e1c393
2 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/lispref/display.texi
View file

@ -5416,10 +5416,9 @@ Every image descriptor must include this property.
@item :file @var{file}
This says to load the image from file @var{file}. If @var{file} is
not an absolute file name, it is expanded relative to the
@file{images} subdirectory of @code{data-directory}, and failing that,
relative to the directories listed by @code{x-bitmap-file-path}
(@pxref{Face Attributes}).
not an absolute file name, it is expanded relative to each of the
directories mentioned by @code{image-load-path} (@pxref{Defining
Images}).
@item :data @var{data}
This specifies the raw image data. Each image descriptor must have
@ -6367,7 +6366,9 @@ Supports the @code{:index} property. @xref{Multi-Frame Images}.
This function creates and returns an image descriptor which uses the
data in @var{file-or-data}. @var{file-or-data} can be a file name or
a string containing the image data; @var{data-p} should be @code{nil}
for the former case, non-@code{nil} for the latter case.
for the former case, non-@code{nil} for the latter case. If
@var{file-or-data} is a relative file name, the function will search
for it in directories mentioned in @code{image-load-path}.
The optional argument @var{type} is a symbol specifying the image type.
If @var{type} is omitted or @code{nil}, @code{create-image} tries to

5
lisp/image.el
View file

@ -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