changeset 4320:9f41f41891aa

Code review: update doc strings, elaborate on use and TODO
author Florian Krupicka <florian.krupicka@googlemail.com>
date Mon, 18 Aug 2008 00:39:46 +0200
parents cf1d2cc4397a
children 4476d5ca521c
files MoinMoin/web/profile.py
diffstat 1 files changed, 10 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/web/profile.py	Mon Aug 18 00:12:09 2008 +0200
+++ b/MoinMoin/web/profile.py	Mon Aug 18 00:39:46 2008 +0200
@@ -3,9 +3,17 @@
     MoinMoin - WSGI middlewares for profiling
 
     These have been ported from server_standalone to provide application
-    profiling for a WSGI application.
+    profiling for a WSGI application. They are implemented as WSGI
+    middlewares, so they can be plugged right in front of the MoinMoin
+    WSGI application. Attention has to be payed, that at the end of
+    profiling the `shutdown`-method has to be invoked, so that the
+    middlewares can write the reports to the filesystem.
 
-    TODO: put them back in place, where the old profilers used to be
+    TODO: in pre-WSGI MoinMoin those profilers where integrated in
+          the standalone server and also some other gateway interfaces.
+          In the near future the middlewares here could be again made
+          configurable automatically with command line switches or
+          wiki configuration options.
 
     @copyright: 2008 MoinMoin:FlorianKrupicka,
     @license: GNU GPL, see COPYING for details.