Mercurial > hg > xemacs-beta

diff lisp/find-paths.el @ 2456:f4e405a9d18d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2004-12-27 12:25:14 by michaels] 2004-12-18 Mike Sperber <mike@xemacs.org> * package-admin.el: * startup.el: Reflect the changes made in packages.el. * packages.el: * loadup.el: * make-docfile.el: * package-admin.el: * startup.el: * update-elc.el (early-package-hierarchies) (late-package-hierarchies) (last-package-hierarchies): Renamed these from `early-packages', `late-packages' and `last-packages'. * packages.el: Rewrote package-finding logic to separate the concepts of "package directories" and "package hierarchies". Added explanation of these concepts. * setup-paths.el: * find-paths.el: Added parameter descriptions to some of the docstrings. * packages.el, setup-paths.el: Make terminology more explicit about "package hierarchies" * startup.el (emacs-roots, emacs-data-roots) (user-init-directory-base, user-init-directory) (user-init-file-base, user-init-file-base-list) (user-home-init-file-base-list) (load-home-init-file, load-user-init-file-p) (startup-find-load-path, startup-setup-paths) (startup-find-load-path-for-packages): Moved these back from setup-paths.el where they belong---setup-paths.el now again, as documented, contains no code that sets global variables. (They were moved from startup.el to setup-paths.el on 2003-02-28.) Clarify that in the comment at the top. * setup-paths.el (paths-find-emacs-roots): Restored `invocation-directory' 'invocation-name' parameters removed on 2003-02-28; they're useful for debugging.
author michaels
date Mon, 27 Dec 2004 12:27:05 +0000
parents 13a418960a88
children 505a24c07ba9
line wrap: on
line diff
--- a/lisp/find-paths.el	Sun Dec 26 22:52:34 2004 +0000
+++ b/lisp/find-paths.el	Mon Dec 27 12:27:05 2004 +0000
@@ -5,7 +5,7 @@
 ;; Copyright (C) 1995 Board of Trustees, University of Illinois
 ;; Copyright (C) 2003 Ben Wing.
 
-;; Author: Mike Sperber <sperber@informatik.uni-tuebingen.de>
+;; Author: Mike Sperber <mike@xemacs.org>
 ;; Maintainer: XEmacs Development Team
 ;; Keywords: internal, dumped
 
@@ -125,7 +125,10 @@
       path)))
 
 (defun paths-construct-emacs-directory (root suffix base)
-  "Construct a directory name within the XEmacs hierarchy."
+  "Construct a directory name within the XEmacs hierarchy.
+ROOT must be a an installation root.
+SUFFIX is the subdirectory from there.
+BASE is the base to look for."
   (file-name-as-directory
    (expand-file-name
     (concat
@@ -165,7 +168,12 @@
 	nil))))
 
 (defun paths-find-site-directory (roots base &optional envvar default)
-  "Find a site-specific directory in the XEmacs hierarchy."
+  "Find a site-specific directory in the XEmacs hierarchy.
+ROOT must be a an installation root.
+BASE is the base to look for.
+ENVVAR is the name of the environment variable that might also
+specify the directory.
+DEFAULT is the preferred value."
   (paths-find-emacs-directory roots
 			      (file-name-as-directory
 			       (paths-construct-path (list
@@ -177,6 +185,12 @@
 (defun paths-find-version-directory (roots base
 				     &optional envvar default enforce-version)
   "Find a version-specific directory in the XEmacs hierarchy.
+
+ROOT must be a an installation root.
+BASE is the base to look for.
+ENVVAR is the name of the environment variable that might also
+specify the directory.
+DEFAULT is the preferred value.
 If ENFORCE-VERSION is non-nil, the directory must contain the XEmacs version."
   (paths-find-emacs-directory roots
 			      (file-name-as-directory
@@ -188,7 +202,12 @@
 			      enforce-version))
 
 (defun paths-find-architecture-directory (roots base &optional envvar default)
-  "Find an architecture-specific directory in the XEmacs hierarchy."
+  "Find an architecture-specific directory in the XEmacs hierarchy.
+ROOT must be a an installation root.
+BASE is the base to look for.
+ENVVAR is the name of the environment variable that might also
+specify the directory.
+DEFAULT is the preferred value."
   (or
    ;; from more to less specific
    (paths-find-version-directory roots
@@ -203,11 +222,12 @@
 				 envvar)))
 
 (defun construct-emacs-version-name ()
-  "Construct the raw XEmacs version number."
+  "Construct a string from the raw XEmacs version number."
   (concat emacs-program-name "-" emacs-program-version))
 
 (defun paths-directories-which-exist (directories)
-  "Return the directories among DIRECTORIES."
+  "Return the directories among DIRECTORIES.
+DIRECTORIES is a list of strings."
   (let ((reverse-directories '()))
     (while directories
       (if (paths-file-readable-directory-p (car directories))
@@ -218,7 +238,7 @@
     (reverse reverse-directories)))
 
 (defun paths-uniq-append (list-1 list-2)
-  "Append LIST-1 and LIST-2, omitting duplicates."
+  "Append LIST-1 and LIST-2, omitting EQUAL duplicates."
   (let ((reverse-survivors '()))
     (while list-2
       (if (null (member (car list-2) list-1))