From 98f9601550d5298b805ee3aadfae07f8972d4bcf Mon Sep 17 00:00:00 2001
From: Aymeric Augustin
Date: Mon, 28 Oct 2013 21:58:20 +0100
Subject: Document performance implications.

Fix #78.
---
 docs/tips.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 docs/tips.rst

(limited to 'docs/tips.rst')

diff --git a/docs/tips.rst b/docs/tips.rst
new file mode 100644
index 0000000..25e2859
--- /dev/null
+++ b/docs/tips.rst
@@ -0,0 +1,29 @@
+Tips
+====
+
+Performance considerations
+--------------------------
+
+The Debug Toolbar adds some overhead to the rendering of each page. Depending
+on your project, this overhead may slow down page loads significantly. If that
+makes development impractical, you can tune some settings to disable the most
+expensive features and restore decent response times.
+
+The SQL panel may be the culprit if your view performs many SQL queries. You
+should attempt to minimize the number of SQL queries, but this isn't always
+possible, for instance if you're using a CMS and have turned off caching for
+development. In that case, setting ``ENABLE_STACKTRACES`` to ``False`` in the
+``DEBUG_TOOLBAR_CONFIG`` setting will help.
+
+The cache panel is very similar to the SQL panel, except it isn't always a bad
+practice to make many cache queries in a view. Setting ``ENABLE_STACKTRACES``
+to ``False`` will help there too.
+
+The template panel may be slow if your views or context processors return
+large contexts and your templates have complex inheritance or inclusion
+schemes. In that case, you should set ``SHOW_TEMPLATE_CONTEXT`` to ``False``
+in the ``DEBUG_TOOLBAR_CONFIG`` setting.
+
+Finally, if you don't need the panels that are slowing down your application,
+you can customize the ``DEBUG_TOOLBAR_PANELS`` setting to include only the
+panels you actually use.
-- 
cgit v1.2.3