#77549 by Moshe, improved install profile documentation.

1 files changed, 11 insertions, 6 deletions

diff --git a/modules/system/system.module b/modules/system/system.module
index 576702b01..30f4c9108 100644
--- a/modules/system/system.module
+++ b/modules/system/system.module
@@ -943,12 +943,13 @@ function system_default_region($theme) {
 
 /**
  * Returns an array of files objects of the given type from the site-wide
- * directory (i.e. modules/), the all-sites directory (i.e. sites/all/modules/)
- * and site-specific directory (i. e. sites/somesite/modules/). The returned
- * array will be keyed using the key specified (name, basename, filename). Using
- * name or basename will cause site- specific files to shadow files in the
- * default directories. That is, if a file with the same name appears in both
- * the site-wide directory and site-specific directory, only the site-specific
+ * directory (i.e. modules/), the all-sites directory (i.e.
+ * sites/all/modules/), the profiles directory, and site-specific directory
+ * (i.e. sites/somesite/modules/). The returned array will be keyed using the
+ * key specified (name, basename, filename). Using name or basename will cause
+ * site-specific files to be prioritized over similar files in the default
+ * directories. That is, if a file with the same name appears in both the
+ * site-wide directory and site-specific directory, only the site-specific
  * version will be included.
  *
  * @param $mask
@@ -974,6 +975,10 @@ function system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
   // Always search sites/all/* as well as the global directories
   $searchdir[] = 'sites/all';
 
+  // The 'profiles' directory contains pristine collections of modules and
+  // themes as organized by a distribution.  It is pristine in the same way
+  // that /modules is pristine for core; users should avoid changing anything
+  // there in favor of sites/all or sites/<domain> directories.
   if (file_exists("profiles/$profile/$directory")) {
     $searchdir[] = "profiles/$profile/$directory";
   }