summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAymeric Augustin <aymeric.augustin@m4x.org>2012-10-27 11:49:46 +0200
committerAymeric Augustin <aymeric.augustin@m4x.org>2012-10-27 18:31:00 +0200
commit83ba0a9d4b078fd177ac5c06699486d708d62bff (patch)
treee0aa4d844f6542e45be6489c11c9e2fd8f3ef7c0 /docs
parent908efca81723af7a3f4fb5b586e530ed7cd3952b (diff)
Fixed #18978 -- Moved cleanup command to sessions.
This removes a dependency of 'core' on 'contrib'.
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/deprecation.txt5
-rw-r--r--docs/ref/django-admin.txt15
-rw-r--r--docs/releases/1.5.txt13
-rw-r--r--docs/topics/http/sessions.txt2
4 files changed, 33 insertions, 2 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index 10bbfe1a91..77371c8608 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -293,6 +293,11 @@ these changes.
* The ``AUTH_PROFILE_MODULE`` setting, and the ``get_profile()`` method on
the User model, will be removed.
+* The ``cleanup`` management command will be removed. It's replaced by
+ ``clearsessions``.
+
+* The ``daily_cleanup.py`` script will be removed.
+
2.0
---
diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt
index 7fa7539985..833db0839c 100644
--- a/docs/ref/django-admin.txt
+++ b/docs/ref/django-admin.txt
@@ -96,6 +96,9 @@ cleanup
Can be run as a cronjob or directly to clean out old data from the database
(only expired sessions at the moment).
+.. versionchanged:: 1.5
+ :djadmin:`cleanup` is deprecated. Use :djadmin:`clearsessions` instead.
+
compilemessages
---------------
@@ -1187,6 +1190,18 @@ This command is only available if :doc:`GeoDjango </ref/contrib/gis/index>`
Please refer to its :djadmin:`description <ogrinspect>` in the GeoDjango
documentation.
+``django.contrib.sessions``
+---------------------------
+
+clearsessions
+~~~~~~~~~~~~~~~
+
+.. django-admin:: clearsessions
+
+Can be run as a cron job or directly to clean out expired sessions.
+
+This is only supported by the database backend at the moment.
+
``django.contrib.sitemaps``
---------------------------
diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt
index a0ce3cc7a4..ebf88e83b9 100644
--- a/docs/releases/1.5.txt
+++ b/docs/releases/1.5.txt
@@ -613,7 +613,6 @@ Define a ``__str__`` method and apply the
The :func:`~django.utils.itercompat.product` function has been deprecated. Use
the built-in :func:`itertools.product` instead.
-
``django.utils.markup``
~~~~~~~~~~~~~~~~~~~~~~~
@@ -621,3 +620,15 @@ The markup contrib module has been deprecated and will follow an accelerated
deprecation schedule. Direct use of python markup libraries or 3rd party tag
libraries is preferred to Django maintaining this functionality in the
framework.
+
+``cleanup`` management command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The :djadmin:`cleanup` management command has been deprecated and replaced by
+:djadmin:`clearsessions`.
+
+``daily_cleanup.py`` script
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The undocumented ``daily_cleanup.py`` script has been deprecated. Use the
+:djadmin:`clearsessions` management command instead.
diff --git a/docs/topics/http/sessions.txt b/docs/topics/http/sessions.txt
index 15f9f7feba..0082b75db1 100644
--- a/docs/topics/http/sessions.txt
+++ b/docs/topics/http/sessions.txt
@@ -460,7 +460,7 @@ table. Django updates this row each time the session data changes. If the user
logs out manually, Django deletes the row. But if the user does *not* log out,
the row never gets deleted.
-Django provides a sample clean-up script: ``django-admin.py cleanup``.
+Django provides a sample clean-up script: ``django-admin.py clearsessions``.
That script deletes any session in the session table whose ``expire_date`` is
in the past -- but your application may have different requirements.