[Emacs-diffs] /srv/bzr/emacs/trunk r103971: Doc fixes for package.el.

[Chong Yidong]

------------------------------------------------------------
revno: 103971
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Thu 2011-04-21 22:35:48 -0400
message:
  Doc fixes for package.el.
  
  * emacs-lisp/package.el (package--builtins, package-alist)
  (package-load-descriptor, package-built-in-p, package-activate)
  (define-package, package-installed-p)
  (package-compute-transaction, package-buffer-info)
  (package--push): Doc fix.  Distinguish more clearly between
  version strings and version lists.
modified:
  lisp/ChangeLog
  lisp/emacs-lisp/package.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2011-04-21 12:24:46 +0000
+++ b/lisp/ChangeLog    2011-04-22 02:35:48 +0000
@@ -1,3 +1,12 @@
+2011-04-22  Chong Yidong  <address@hidden>
+
+       * emacs-lisp/package.el (package--builtins, package-alist)
+       (package-load-descriptor, package-built-in-p, package-activate)
+       (define-package, package-installed-p)
+       (package-compute-transaction, package-buffer-info)
+       (package--push): Doc fix.  Distinguish more clearly between
+       version strings and version lists.
+
 2011-04-21  Juanma Barranquero  <address@hidden>
 
        Lexical-binding cleanup.

=== modified file 'lisp/emacs-lisp/package.el'
--- a/lisp/emacs-lisp/package.el        2011-04-06 20:33:30 +0000
+++ b/lisp/emacs-lisp/package.el        2011-04-22 02:35:48 +0000
@@ -290,9 +290,11 @@
 
 Each element has the form (PKG . DESC), where PKG is a package
 name (a symbol) and DESC is a vector that describes the package.
-The vector DESC has the form [VERSION REQS DOCSTRING].
-  VERSION is a version list.
-  REQS is a list of packages (symbols) required by the package.
+The vector DESC has the form [VERSION-LIST REQS DOCSTRING].
+  VERSION-LIST is a version list.
+  REQS is a list of packages required by the package, each
+   requirement having the form (NAME VL), where NAME is a string
+   and VL is a version list.
   DOCSTRING is a brief description of the package.")
 (put 'package--builtins 'risky-local-variable t)
 
@@ -301,9 +303,11 @@
 Each element has the form (PKG . DESC), where PKG is a package
 name (a symbol) and DESC is a vector that describes the package.
 
-The vector DESC has the form [VERSION REQS DOCSTRING].
-  VERSION is a version list.
-  REQS is a list of packages (symbols) required by the package.
+The vector DESC has the form [VERSION-LIST REQS DOCSTRING].
+  VERSION-LIST is a version list.
+  REQS is a list of packages required by the package, each
+   requirement having the form (NAME VL) where NAME is a string
+   and VL is a version list.
   DOCSTRING is a brief description of the package.
 
 This variable is set automatically by `package-load-descriptor',
@@ -358,8 +362,8 @@
 
 (defun package-load-descriptor (dir package)
   "Load the description file in directory DIR for package PACKAGE.
-Here, PACKAGE is a string of the form NAME-VER, where NAME is the
-package name and VER is its version."
+Here, PACKAGE is a string of the form NAME-VERSION, where NAME is
+the package name and VERSION is its version."
   (let* ((pkg-dir (expand-file-name package dir))
         (pkg-file (expand-file-name
                    (concat (package-strip-version package) "-pkg")
@@ -452,18 +456,21 @@
     ;; Don't return nil.
     t))
 
-(defun package-built-in-p (package &optional version)
-  "Return true if PACKAGE, of VERSION or newer, is built-in to Emacs."
+(defun package-built-in-p (package &optional min-version)
+  "Return true if PACKAGE is built-in to Emacs.
+Optional arg MIN-VERSION, if non-nil, should be a version list
+specifying the minimum acceptable version."
   (require 'finder-inf nil t) ; For `package--builtins'.
   (let ((elt (assq package package--builtins)))
-    (and elt (version-list-<= version (package-desc-vers (cdr elt))))))
+    (and elt (min-version-<= min-version (package-desc-vers (cdr elt))))))
 
 ;; This function goes ahead and activates a newer version of a package
 ;; if an older one was already activated.  This is not ideal; we'd at
 ;; least need to check to see if the package has actually been loaded,
 ;; and not merely activated.
-(defun package-activate (package version)
-  "Activate package PACKAGE, of version VERSION or newer.
+(defun package-activate (package min-version)
+  "Activate package PACKAGE, of version MIN-VERSION or newer.
+MIN-VERSION should be a version list.
 If PACKAGE has any dependencies, recursively activate them.
 Return nil if the package could not be activated."
   (let ((pkg-vec (cdr (assq package package-alist)))
@@ -471,11 +478,11 @@
     ;; Check if PACKAGE is available in `package-alist'.
     (when pkg-vec
       (setq available-version (package-desc-vers pkg-vec)
-           found (version-list-<= version available-version)))
+           found (version-list-<= min-version available-version)))
     (cond
      ;; If no such package is found, maybe it's built-in.
      ((null found)
-      (package-built-in-p package version))
+      (package-built-in-p package min-version))
      ;; If the package is already activated, just return t.
      ((memq package package-activated-list)
       t)
@@ -512,11 +519,11 @@
                                &rest extra-properties)
   "Define a new package.
 NAME-STRING is the name of the package, as a string.
-VERSION-STRING is the version of the package, as a list of
-integers of the form produced by `version-to-list'.
+VERSION-STRING is the version of the package, as a string.
 DOCSTRING is a short description of the package, a string.
 REQUIREMENTS is a list of dependencies on other packages.
-Each requirement is of the form (OTHER-PACKAGE \"VERSION\").
+ Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION),
+ where OTHER-VERSION is a string.
 
 EXTRA-PROPERTIES is currently unused."
   (let* ((name (intern name-string))
@@ -703,8 +710,8 @@
       (package-unpack name version))))
 
 (defun package-installed-p (package &optional min-version)
-  "Return true if PACKAGE, of VERSION or newer, is installed.
-Built-in packages also qualify."
+  "Return true if PACKAGE, of MIN-VERSION or newer, is installed.
+MIN-VERSION should be a version list."
   (let ((pkg-desc (assq package package-alist)))
     (if pkg-desc
        (version-list-<= min-version
@@ -717,9 +724,9 @@
 PACKAGE-LIST should be a list of package names (symbols).
 
 REQUIREMENTS should be a list of additional requirements; each
-element in this list should have the form (PACKAGE VERSION),
-where PACKAGE is a package name and VERSION is the required
-version of that package (as a list).
+element in this list should have the form (PACKAGE VERSION-LIST),
+where PACKAGE is a package name and VERSION-LIST is the required
+version of that package.
 
 This function recursively computes the requirements of the
 packages in REQUIREMENTS, and returns a list of all the packages
@@ -890,7 +897,8 @@
    [FILENAME REQUIRES DESCRIPTION VERSION COMMENTARY]
 
 FILENAME is the file name, a string, sans the \".el\" extension.
-REQUIRES is a requires list, or nil.
+REQUIRES is a list of requirements, each requirement having the
+ form (NAME VER); NAME is a string and VER is a version list.
 DESCRIPTION is the package description, a string.
 VERSION is the version, a string.
 COMMENTARY is the commentary section, a string, or nil if none.
@@ -1329,8 +1337,8 @@
   "Convenience macro for `package-menu--generate'.
 If the alist stored in the symbol LISTNAME lacks an entry for a
 package PACKAGE with descriptor DESC, add one.  The alist is
-keyed with cons cells (PACKAGE . VERSION), where PACKAGE is a
-symbol and VERSION is a version list."
+keyed with cons cells (PACKAGE . VERSION-LIST), where PACKAGE is
+a symbol and VERSION-LIST is a version list."
   `(let* ((version (package-desc-vers ,desc))
          (key (cons ,package version)))
      (unless (assoc key ,listname)