minor #13819 Provides a way to override cache and log folders from the ENV (Plopix)

javiereguiluz · javiereguiluz · commit 6890cb8c118d · 2020-06-13T17:14:28.000+02:00
This PR was merged into the master branch. Discussion ---------- Provides a way to override cache and log folders from the ENV Related to this new feature symfony/symfony#37114. But I wonder if we have not oversimplified this PR: symfony/symfony#37114 Actually doing the documentation #13787 I figured that with #37114 we removed the important split per `env`. In development mode (docker or not) we could definitely have the same project working in N Symfony different environments and this new `APP_CACHE_DIR` will only set the same path for all environments. That would be manageable in the Virtualhost but in CLI that would be a pain to manage. Also, we could rely on the DotEnv mechanism, but that could be really easy to forget. I wonder if we should not change the code to: symfony/symfony#37232 Depending on the decisions I will update the doc here. Commits ------- 88b081c Provides a way to override cache and log folders from the ENV
diff --git a/configuration/override_dir_structure.rst b/configuration/override_dir_structure.rst
@@ -41,8 +41,8 @@ at your project root directory.
 Override the Cache Directory
 ----------------------------
 
-You can change the default cache directory by overriding the ``getCacheDir()``
-method in the ``Kernel`` class of your application::
+Changing the cache directory can be achieved by overriding the
+``getCacheDir()`` method in the ``Kernel`` class of your application::
 
     // src/Kernel.php
 
@@ -61,6 +61,9 @@ In this code, ``$this->environment`` is the current environment (i.e. ``dev``).
 In this case you have changed the location of the cache directory to
 ``var/{environment}/cache/``.
 
+This can also be achieved using a predefined environment variable named
+``APP_CACHE_DIR``. Its value must be the full path of the cache folder.
+
 .. caution::
 
     You should keep the cache directory different for each environment,
@@ -73,9 +76,11 @@ In this case you have changed the location of the cache directory to
 Override the Log Directory
 --------------------------
 
-Overriding the ``var/log/`` directory is the same as overriding the ``var/cache/``
-directory. The only difference is that you need to override the ``getLogDir()``
-method::
+Overriding the ``var/log/`` directory is almost the same as overriding the
+``var/cache/`` directory.
+
+You can do it overriding the ``getLogDir()`` method in the ``Kernel`` class of
+your application::
 
     // src/Kernel.php
 
@@ -92,6 +97,8 @@ method::
 
 Here you have changed the location of the directory to ``var/{environment}/log/``.
 
+And you can also do it using the predefined ``APP_LOG_DIR`` environment variable.
+
 .. _override-templates-dir:
 
 Override the Templates Directory
