Skip to content
This repository
Browse code

Merge pull request #50 from goodwillcoding/master

 	updated docs: added warning for filecache clearing, atexit and …  possible abnormal temination issues.
  • Loading branch information...
commit 443090d8fcb7964edbb4092ce49012f44e5b5aaa 2 parents 83b1c8b + ceeb680
Domen Kožar authored November 24, 2012

Showing 1 changed file with 17 additions and 3 deletions. Show diff stats Hide diff stats

  1. 20  docs/index.rst
20  docs/index.rst
Source Rendered
@@ -378,7 +378,7 @@ jinja2.bytecode_caching
378 378
 
379 379
 ``true`` or ``false`` to enable filesystem bytecode caching. Defaults to
380 380
 ``true``. See :ref:`Bytecode Cache <jinja2:bytecode-cache>` in Jinja2
381  
-documentation. 
  381
+documentation.
382 382
 
383 383
 .. _setting_jinja2_byte_cache_dir:
384 384
 
@@ -390,8 +390,22 @@ temporary directory. See :py:class:`jinja2.FileSystemBytecodeCache`.
390 390
 
391 391
 .. note::
392 392
 
393  
-   Directory will be deleted by py:func:`jinja2.BytecodeCache.clear`,
394  
-   which is called by :func:`atexit.register`.
  393
+   :term:`pyramid_jinja2` will attempt to delete the cached files by
  394
+   calling :py:func:`jinja2.BytecodeCache.clear` from function
  395
+   registered by :py:func:`atexit.register`.
  396
+
  397
+   .. warning ::
  398
+
  399
+      As noted by the `atexit documentation
  400
+      <http://docs.python.org/2/library/atexit.html>`__
  401
+      the functions registered by the module will only be called
  402
+      **upon normal termination**. In case of abnormal program
  403
+      termination the files may remain, littering your file system
  404
+      (and eating up inodes).
  405
+
  406
+      You are **strongly advised** to consider an additional clean up
  407
+      strategy (such as cron) to check and remove such files.
  408
+
395 409
 
396 410
 .. _jinja2_filters:
397 411
 

0 notes on commit 443090d

Please sign in to comment.
Something went wrong with that request. Please try again.