Merge branch '2.0' into 2.1

weaverryan · weaverryan · commit 725d1071393c · 2013-03-03T20:10:34.000-06:00
diff --git a/cookbook/configuration/override_dir_structure.rst b/cookbook/configuration/override_dir_structure.rst
@@ -23,6 +23,8 @@ directory structure is:
         app.php
         ...
 
+.. _override-cache-dir:
+
 Override the ``cache`` directory
 --------------------------------
 
@@ -53,6 +55,8 @@ the location of the cache directory to ``app/{environment}/cache``.
     its own cached config files, and so each needs its own directory to store
     those cache files.
 
+.. _override-logs-dir:
+
 Override the ``logs`` directory
 -------------------------------
 
diff --git a/reference/configuration/kernel.rst b/reference/configuration/kernel.rst
@@ -0,0 +1,74 @@
+.. index::
+    single: Configuration reference; Kernel class
+
+Configuring in the Kernel (e.g. AppKernel)
+==========================================
+
+Some configuration can be done on the kernel class itself (usually called
+``app/AppKernel.php``). You can do this by overriding specific methods in
+the parent :class:`Symfony\\Component\\HttpKernel\\Kernel` class.
+
+Configuration
+-------------
+
+* `Kernel Name`_
+* `Root Directory`_
+* `Cache Directory`_
+* `Log Directory`_
+
+Kernel Name
+~~~~~~~~~~~
+
+**type**: ``string`` **default**: ``app`` (i.e. the directory name holding the kernel class)
+
+To change this setting, override the :method:`Symfony\\Component\\HttpKernel\\Kernel::getName`
+method. Alternatively, move your kernel into a different directory. For example,
+if you moved the kernel into a ``foo`` directory (instead of ``app``), the
+kernel name will be ``foo``.
+
+The name of the kernel isn't usually directly important - it's used in the
+generation of cache files. If you have an application with multiple kernels,
+the easiest way to make each have a unique name is to duplicate the ``app``
+directory and rename it to something else (e.g. ``foo``).
+
+Root Directory
+~~~~~~~~~~~~~~
+
+**type**: ``string`` **default**: the directory of ``AppKernel``
+
+This returns the root directory of your kernel. If you use the Symfony Standard
+edition, the root directory refers to the ``app`` directory.
+
+To change this setting, override the
+:method:`Symfony\\Component\\HttpKernel\\Kernel::getRootDir` method::
+
+    // app/AppKernel.php
+
+    // ...
+    class AppKernel extends Kernel
+    {
+        // ...
+
+        public function getRootDir()
+        {
+            return realpath(parent::getRootDir().'/../');
+        }
+    }
+
+Cache Directory
+~~~~~~~~~~~~~~~
+
+**type**: ``string`` **default**: ``$this->rootDir/cache/$this->environment``
+
+This returns the path to the cache directory. To change it, override the
+:method:`Symfony\\Component\\HttpKernel\\Kernel::getCacheDir` method. Read
+":ref:`override-cache-dir`" for more information.
+
+Log Directory
+~~~~~~~~~~~~~
+
+**type**: ``string`` **default**: ``$this->rootDir/logs``
+
+This returns the path to the log directory. To change it, override the
+:method:`Symfony\\Component\\HttpKernel\\Kernel::getLogDir` method. Read
+":ref:`override-logs-dir`" for more information.
diff --git a/reference/index.rst b/reference/index.rst
@@ -12,6 +12,7 @@ Reference Documents
     configuration/twig
     configuration/monolog
     configuration/web_profiler
+    configuration/kernel
 
     forms/types
     forms/twig_reference
diff --git a/reference/map.rst.inc b/reference/map.rst.inc
@@ -14,6 +14,8 @@
   * :doc:`monolog </reference/configuration/monolog>`
   * :doc:`web_profiler </reference/configuration/web_profiler>`
 
+* :doc:`Configuring the Kernel (e.g. AppKernel) </reference/configuration/kernel>`
+
 * **Forms and Validation**
 
   * :doc:`Form Field Type Reference</reference/forms/types>`
