github/melpa
1
0
Fork 0
mirror of https://github.com/correl/melpa.git synced 2024-11-22 19:18:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

Extend docstring for pb/read-recipe

Browse source
This commit is contained in:
Steve Purcell 2015-01-06 13:07:16 +00:00
parent 49ceee7b4e
commit 1e8cfb4717
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
package-build.el
View file

@ -804,7 +804,11 @@ of the same-named package which is to be kept."
(pb/entry-file-name archive-entry))))
(defun pb/read-recipe (file-name)
"Return the plist of recipe info for the package called FILE-NAME."
"Return the plist of recipe info for the package called FILE-NAME.
It performs some basic checks on the recipe to ensure that known keys have
values of the right types, and raises an error if that is the not the case.
If unknown keys or invalid combinations of keys are supplied then errors will
only be caught when an attempt is made to build the recipe."
(let* ((pkg-info (pb/read-from-file file-name))
(pkg-name (car pkg-info))
(rest (cdr pkg-info)))