Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #1071846 by gbrands: Fixed conf_path() doc needs cleanup.

merge-requests/26/head
webchick 2011-06-30 00:01:40 -07:00
parent 41efebcf07
commit 214fb8de72
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
includes/bootstrap.inc
View File

@ -311,31 +311,30 @@ function timer_stop($name) {
} }
/** /**
* Find the appropriate configuration directory. * Finds the appropriate configuration directory.
* *
* Try finding a matching configuration directory by stripping the website's * Finds a matching configuration directory by stripping the website's
* hostname from left to right and pathname from right to left. The first * hostname from left to right and pathname from right to left. The first
* configuration file found will be used; the remaining will ignored. If no * configuration file found will be used and the remaining ones will be ignored.
* configuration file is found, return a default value '$confdir/default'. * If no configuration file is found, return a default value '$confdir/default'.
* *
* Example for a fictitious site installed at * With a site located at http://www.example.com:8080/mysite/test/, the file,
* http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in * settings.php, is searched for in the following directories:
* the following directories:
* *
* 1. $confdir/8080.www.drupal.org.mysite.test * 1. $confdir/8080.www.example.com.mysite.test
* 2. $confdir/www.drupal.org.mysite.test * 2. $confdir/www.example.com.mysite.test
* 3. $confdir/drupal.org.mysite.test * 3. $confdir/example.com.mysite.test
* 4. $confdir/org.mysite.test * 4. $confdir/com.mysite.test
* *
* 5. $confdir/8080.www.drupal.org.mysite * 5. $confdir/8080.www.example.com.mysite
* 6. $confdir/www.drupal.org.mysite * 6. $confdir/www.example.com.mysite
* 7. $confdir/drupal.org.mysite * 7. $confdir/example.com.mysite
* 8. $confdir/org.mysite * 8. $confdir/com.mysite
* *
* 9. $confdir/8080.www.drupal.org * 9. $confdir/8080.www.example.com
* 10. $confdir/www.drupal.org * 10. $confdir/www.example.com
* 11. $confdir/drupal.org * 11. $confdir/example.com
* 12. $confdir/org * 12. $confdir/com
* *
* 13. $confdir/default * 13. $confdir/default
* *
@ -343,18 +342,18 @@ function timer_stop($name) {
* prior to scanning for directories. It should define an associative array * prior to scanning for directories. It should define an associative array
* named $sites, which maps domains to directories. It should be in the form * named $sites, which maps domains to directories. It should be in the form
* of: * of:
* * @code
* $sites = array( * $sites = array(
* 'The url to alias' => 'A directory within the sites directory' * 'The url to alias' => 'A directory within the sites directory'
* ); * );
* * @endcode
* For example: * For example:
* * @code
* $sites = array( * $sites = array(
* 'devexample.com' => 'example.com', * 'devexample.com' => 'example.com',
* 'localhost.example' => 'example.com', * 'localhost.example' => 'example.com',
* ); * );
* * @endcode
* The above array will cause Drupal to look for a directory named * The above array will cause Drupal to look for a directory named
* "example.com" in the sites directory whenever a request comes from * "example.com" in the sites directory whenever a request comes from
* "example.com", "devexample.com", or "localhost/example". That is useful * "example.com", "devexample.com", or "localhost/example". That is useful
@ -363,14 +362,15 @@ function timer_stop($name) {
* (files, system table, etc.) this will ensure the paths are correct while * (files, system table, etc.) this will ensure the paths are correct while
* accessed on development servers. * accessed on development servers.
* *
* @param $require_settings * @param bool $require_settings
* Only configuration directories with an existing settings.php file * Only configuration directories with an existing settings.php file
* will be recognized. Defaults to TRUE. During initial installation, * will be recognized. Defaults to TRUE. During initial installation,
* this is set to FALSE so that Drupal can detect a matching directory, * this is set to FALSE so that Drupal can detect a matching directory,
* then create a new settings.php file in it. * then create a new settings.php file in it.
* @param reset * @param bool $reset
* Force a full search for matching directories even if one had been * Force a full search for matching directories even if one had been
* found previously. * found previously. Defaults to FALSE.
*
* @return * @return
* The path of the matching directory. * The path of the matching directory.
*/ */