[AC21.5] Document ROOT(S) arguments correctly in find-paths.el

[Stephen J. Turnbull]

APPROVE COMMIT 21.5

Mike, these seem obviously correct, but please check me anyway.

Index: lisp/ChangeLog
===================================================================
RCS file: /pack/xemacscvs/XEmacs/xemacs/lisp/ChangeLog,v
retrieving revision 1.781
diff -u -r1.781 ChangeLog
--- lisp/ChangeLog	17 Dec 2006 13:41:33 -0000	1.781
+++ lisp/ChangeLog	19 Dec 2006 15:16:57 -0000
@@ -0,0 +1,12 @@
+2006-12-19  Stephen J. Turnbull  <stephen at xemacs.org>
+
+	* find-paths.el (paths-construct-emacs-directory):
+	(paths-for-each-emacs-directory):
+	(paths-find-site-directory):
+	(paths-find-site-directories):
+	(paths-for-each-version-directory):
+	(paths-find-version-directory):
+	(paths-find-version-directories):
+	(paths-find-architecture-directory):
+	Document ROOT(S) argument correctly.
+

Index: lisp/find-paths.el
===================================================================
RCS file: /pack/xemacscvs/XEmacs/xemacs/lisp/find-paths.el,v
retrieving revision 1.29
diff -u -r1.29 find-paths.el
--- lisp/find-paths.el	15 Jan 2005 15:17:36 -0000	1.29
+++ lisp/find-paths.el	19 Dec 2006 15:16:57 -0000
@@ -126,7 +126,7 @@
 
 (defun paths-construct-emacs-directory (root suffix base)
   "Construct a directory name within the XEmacs hierarchy.
-ROOT must be a an installation root.
+ROOT must be an installation root.
 SUFFIX is the subdirectory from there.
 BASE is the base to look for."
   (file-name-as-directory
@@ -211,7 +211,7 @@
   "Iterate over the site-specific directories in the XEmacs hierarchy.
 FUNC is a function that called for each directory, with the directory
 as the only argument.
-ROOT must be a an installation root.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.
@@ -227,7 +227,7 @@
 
 (defun paths-find-site-directory (roots base &optional envvar default)
   "Find a site-specific directory in the XEmacs hierarchy.
-ROOT must be a an installation root.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.
@@ -240,7 +240,7 @@
 
 (defun paths-find-site-directories (roots base &optional envvar default)
   "Find a list of site-specific directories in the XEmacs hierarchy.
-ROOT must be a an installation root.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.
@@ -257,7 +257,7 @@
   "Iterate over version-specific directories in the XEmacs hierarchy.
 FUNC is a function that called for each directory, with the directory
 as the only argument.
-ROOT must be a an installation root.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.
@@ -275,7 +275,7 @@
 (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.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.
@@ -290,7 +290,7 @@
 (defun paths-find-version-directories (roots base
 				       &optional envvar default enforce-version)
   "Find a list of version-specific directories in the XEmacs hierarchy.
-ROOT must be a an installation root.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.
@@ -305,7 +305,7 @@
 
 (defun paths-find-architecture-directory (roots base &optional envvar default)
   "Find an architecture-specific directory in the XEmacs hierarchy.
-ROOT must be a an installation root.
+ROOTS must be a list of installation roots.
 BASE is the base to look for.
 ENVVAR is the name of the environment variable that might also
 specify the directory.