From d433754c71e594513657ad77c21fe484f341bbb4 Mon Sep 17 00:00:00 2001 From: Casey Duncan Date: Sun, 16 Jan 2011 13:39:54 -0700 Subject: clarify --- docs/narr/environment.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'docs/narr/environment.rst') diff --git a/docs/narr/environment.rst b/docs/narr/environment.rst index 7caa1dcc6..0ab057684 100644 --- a/docs/narr/environment.rst +++ b/docs/narr/environment.rst @@ -38,10 +38,11 @@ application-specific configuration settings. Reloading Templates ------------------- -When this value is true, reload templates without a restart, so you can see -changes to templates take effect immediately during development. This flag -is meaningful to Chameleon and Mako templates, as well as most third-party -template rendering extensions. +When this value is true, templates are automatically reloaded whenever +they are modified without restarting the application, so you can see +changes to templates take effect immediately during development. This +flag is meaningful to Chameleon and Mako templates, as well as most +third-party template rendering extensions. +---------------------------------+-----------------------------+ | Environment Variable Name | Config File Setting Name | -- cgit v1.2.3 From 496cb6fc2e7e28c4f583590b1a97bb5118b0049b Mon Sep 17 00:00:00 2001 From: Casey Duncan Date: Sun, 16 Jan 2011 13:57:03 -0700 Subject: add a note explaining why you might want to use envars --- docs/narr/environment.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/narr/environment.rst') diff --git a/docs/narr/environment.rst b/docs/narr/environment.rst index 0ab057684..7b7946aae 100644 --- a/docs/narr/environment.rst +++ b/docs/narr/environment.rst @@ -336,6 +336,14 @@ with ``reload_``). on in one fell swoop, you can use affect settings that do not start with ``reload_*`` such as ``debug_notfound``. +.. note:: + Specifying configuration settings via environment variables is generally + most useful during development, where you may wish to augment or + override the more permanent settings in the configuration file. + This is useful because many of the reload and debug settings may + have performance or security (i.e., disclosure) implications + that make them undesirable in a production environment. + .. index:: single: reload_templates single: reload_assets -- cgit v1.2.3