summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCarl Meyer <carl@oddbird.net>2012-09-08 16:55:29 -0600
committerCarl Meyer <carl@oddbird.net>2012-09-08 16:58:35 -0600
commita78dd109e6c81c49e90e36e9b793bad67c46c23c (patch)
tree08463fe2a3faff8bc942a82042b23f6ce4c5049c /docs
parent518c58296667ffc36f90b873eb97aa99fa00eb1e (diff)
Fixed #15552 -- LOGIN_URL and LOGIN_REDIRECT_URL can take URLpattern names.
Thanks UloPe and Eric Florenzano for the patch, and Malcolm Tredinnick for review.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/settings.txt33
-rw-r--r--docs/releases/1.5.txt6
-rw-r--r--docs/topics/auth.txt7
3 files changed, 26 insertions, 20 deletions
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 4729a2b6f1..f443138569 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -1304,25 +1304,13 @@ The URL where requests are redirected after login when the
This is used by the :func:`~django.contrib.auth.decorators.login_required`
decorator, for example.
-.. _`note on LOGIN_REDIRECT_URL setting`:
-
-.. note::
- You can use :func:`~django.core.urlresolvers.reverse_lazy` to reference
- URLs by their name instead of providing a hardcoded value. Assuming a
- ``urls.py`` with an URLpattern named ``home``::
-
- urlpatterns = patterns('',
- url('^welcome/$', 'test_app.views.home', name='home'),
- )
-
- You can use :func:`~django.core.urlresolvers.reverse_lazy` like this::
-
- from django.core.urlresolvers import reverse_lazy
-
- LOGIN_REDIRECT_URL = reverse_lazy('home')
+.. versionchanged:: 1.5
- This also works fine with localized URLs using
- :func:`~django.conf.urls.i18n.i18n_patterns`.
+This setting now also accepts view function names and
+:ref:`named URL patterns <naming-url-patterns>` which can be used to reduce
+configuration duplication since you no longer have to define the URL in two
+places (``settings`` and URLconf).
+For backward compatibility reasons the default remains unchanged.
.. setting:: LOGIN_URL
@@ -1334,8 +1322,13 @@ Default: ``'/accounts/login/'``
The URL where requests are redirected for login, especially when using the
:func:`~django.contrib.auth.decorators.login_required` decorator.
-.. note::
- See the `note on LOGIN_REDIRECT_URL setting`_
+.. versionchanged:: 1.5
+
+This setting now also accepts view function names and
+:ref:`named URL patterns <naming-url-patterns>` which can be used to reduce
+configuration duplication since you no longer have to define the URL in two
+places (``settings`` and URLconf).
+For backward compatibility reasons the default remains unchanged.
.. setting:: LOGOUT_URL
diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt
index 5578e8efcb..6420239f47 100644
--- a/docs/releases/1.5.txt
+++ b/docs/releases/1.5.txt
@@ -121,6 +121,12 @@ Django 1.5 also includes several smaller improvements worth noting:
argument. By default the batch_size is unlimited except for SQLite where
single batch is limited so that 999 parameters per query isn't exceeded.
+* The :setting:`LOGIN_URL` and :setting:`LOGIN_REDIRECT_URL` settings now also
+ accept view function names and
+ :ref:`named URL patterns <naming-url-patterns>`. This allows you to reduce
+ configuration duplication. More information can be found in the
+ :func:`~django.contrib.auth.decorators.login_required` documentation.
+
Backwards incompatible changes in 1.5
=====================================
diff --git a/docs/topics/auth.txt b/docs/topics/auth.txt
index f8dbbb65a6..c45e4bbaf7 100644
--- a/docs/topics/auth.txt
+++ b/docs/topics/auth.txt
@@ -947,6 +947,13 @@ The login_required decorator
(r'^accounts/login/$', 'django.contrib.auth.views.login'),
+ .. versionchanged:: 1.5
+
+ As of version 1.5 :setting:`settings.LOGIN_URL <LOGIN_URL>` now also accepts
+ view function names and :ref:`named URL patterns <naming-url-patterns>`.
+ This allows you to freely remap your login view within your URLconf
+ without having to update the setting.
+
.. function:: views.login(request, [template_name, redirect_field_name, authentication_form])
**URL name:** ``login``