From: Gergő Tisza <tgr.huwiki@gmail.com>
Date: Sun, 19 Nov 2017 22:19:44 +0000 (-0800)
Subject: Improve documentation of $wgReferrerPolicy
X-Git-Tag: 1.31.0-rc.0~1105^2~1
X-Git-Url: http://git.cyclocoop.org/%22.htmlspecialchars%28%24url_syndic%29.%22?a=commitdiff_plain;h=8adb581a6af0c3c39c60642885e7b58df56e7866;p=lhc%2Fweb%2Fwiklou.git

Improve documentation of $wgReferrerPolicy

Reference current version of the spec.

Change-Id: I1cca89b9e46a2b5ae8242715eddfdbd23ccb2d83
---

diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index e50b7a7db1..d0a02de05b 100644
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -316,10 +316,16 @@ $wgAppleTouchIcon = false;
 
 /**
  * Value for the referrer policy meta tag.
- * One of 'never', 'default', 'origin', 'always'. Setting it to false just
- * prevents the meta tag from being output.
- * See https://www.w3.org/TR/referrer-policy/ for details.
+ * One of the values defined in the Referrer Policy specification:
+ * https://w3c.github.io/webappsec-referrer-policy/
+ * ('no-referrer', 'no-referrer-when-downgrade', 'same-origin',
+ * 'origin', 'strict-origin', 'origin-when-cross-origin',
+ * 'strict-origin-when-cross-origin', or 'unsafe-url')
+ * Setting it to false prevents the meta tag from being output
+ * (which results in falling back to the Referrer-Policy header,
+ * or 'no-referrer-when-downgrade' if that's not set either.)
  *
+ * @var string|bool
  * @since 1.25
  */
 $wgReferrerPolicy = false;