Update maintenance.php

[bookstack] / config / cache.php

diff --git a/config/cache.php b/config/cache.php
index 0a95683227fa02dd3ece50b75db2506e40d8574c..43f420457eba43f7b757e48bf0960b6e5a55a2b8 100644 (file)
--- a/config/cache.php
+++ b/config/cache.php
@@ -1,5 +1,13 @@
 <?php
 
+/**
+ * Caching configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+
 // MEMCACHED - Split out configuration into an array
 if (env('CACHE_DRIVER') === 'memcached') {
     $memcachedServerKeys = ['host', 'port', 'weight'];
@@ -14,30 +22,11 @@ if (env('CACHE_DRIVER') === 'memcached') {
 
 return [
 
-    /*
-    |--------------------------------------------------------------------------
-    | Default Cache Store
-    |--------------------------------------------------------------------------
-    |
-    | This option controls the default cache connection that gets used while
-    | using this caching library. This connection is used when another is
-    | not explicitly specified when executing a given caching function.
-    |
-    */
-
+    // Default cache store to use
+    // Can be overridden at cache call-time
     'default' => env('CACHE_DRIVER', 'file'),
 
-    /*
-    |--------------------------------------------------------------------------
-    | Cache Stores
-    |--------------------------------------------------------------------------
-    |
-    | Here you may define all of the cache "stores" for your application as
-    | well as their drivers. You may even define multiple stores for the
-    | same cache driver to group types of items stored in your caches.
-    |
-    */
-
+    // Available caches stores
     'stores' => [
 
         'apc' => [
@@ -71,17 +60,8 @@ return [
 
     ],
 
-    /*
-    |--------------------------------------------------------------------------
-    | Cache Key Prefix
-    |--------------------------------------------------------------------------
-    |
-    | When utilizing a RAM based store such as APC or Memcached, there might
-    | be other applications utilizing the same cache. So, we'll specify a
-    | value to get prefixed to all our keys so we can avoid collisions.
-    |
-    */
-
+    // Cache key prefix
+    // Used to prevent collisions in shared cache systems.
     'prefix' => env('CACHE_PREFIX', 'bookstack'),
 
 ];