minor symfony#8199 Explained the edge-case where the use_referer option doesn't work (javiereguiluz)

xabbuh · xabbuh · commit dcde03c41e16 · 2017-07-21T15:56:03.000+02:00
This PR was squashed before being merged into the 2.7 branch (closes symfony#8199). Discussion ---------- Explained the edge-case where the use_referer option doesn't work This fixes symfony/symfony#17529 (comment). Commits ------- 7a7a842 Explained the edge-case where the use_referer option doesn't work
diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst
@@ -348,7 +348,14 @@ use_referer
 **type**: ``boolean`` **default**: ``false``
 
 If ``true``, the user is redirected to the value stored in the ``HTTP_REFERER``
-header when no previous URL was stored in the session.
+header when no previous URL was stored in the session. If the referrer URL is
+the same as the one generated with the ``login_path`` route, the user is
+redirected to the ``default_target_path`` to avoid a redirection loop.
+
+.. note::
+
+    For historical reasons, and to match the misspelling of the HTTP standard,
+    the option is called ``use_referer`` instead of ``use_referrer``.
 
 .. _reference-security-pbkdf2:
 
