From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Wed, 20 Aug 2014 17:39:36 +0000 (+0200)
Subject: Fix documentation for $wgResourceLoaderLESSVars
X-Git-Tag: 1.31.0-rc.0~14308
X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dcompta/comptes/journal.php?a=commitdiff_plain;h=05047791f1b0b95c2ac92ed96f16f550a81b17a2;p=lhc%2Fweb%2Fwiklou.git

Fix documentation for $wgResourceLoaderLESSVars

* These aren't string values, but LESS code snippets. This rarely
  matters, but it matters very much when it does.
* Changes to the values do not actually trigger cache invalidation.
  Hashed contents are only used for "second-level" cache keys and do
  not make it possible to invalidate module cache.

Change-Id: I373dfedac1e43db4d0aa709384eee7f7e7f1808c
---

diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index 68fa0b5aa7..14799c6464 100644
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -3446,12 +3446,14 @@ $wgResourceLoaderValidateStaticJS = false;
 $wgResourceLoaderExperimentalAsyncLoading = false;
 
 /**
- * Global LESS variables. An associative array binding variable names to CSS
- * string values.
+ * Global LESS variables. An associative array binding variable names to
+ * LESS code snippets representing their values.
  *
- * Because the hashed contents of this array are used to construct the cache key
- * that ResourceLoader uses to look up LESS compilation results, updating this
- * array can be used to deliberately invalidate the set of cached results.
+ * Adding an item here is equivalent to writing `@variable: value;`
+ * at the beginning of all your .less files, with all the consequences.
+ * In particular, string values must be escaped and quoted.
+ *
+ * Changes to LESS variables do not trigger cache invalidation.
  *
  * @par Example:
  * @code
@@ -3469,10 +3471,7 @@ $wgResourceLoaderLESSVars = array();
  * Custom LESS functions. An associative array mapping function name to PHP
  * callable.
  *
- * Changes to LESS functions do not trigger cache invalidation. If you update
- * the behavior of a LESS function and need to invalidate stale compilation
- * results, you can touch one of values in $wgResourceLoaderLESSVars, as
- * documented above.
+ * Changes to LESS functions do not trigger cache invalidation.
  *
  * @since 1.22
  */