[conga-luci-1stgen] RHEL5-active: luci/MAINTAINERS.rst: add Brief intro into debugging (abfdb39)

[Ryan McCabe]

Repository : http://git.fedorahosted.org/git/?p=conga-luci-1stgen.git

On branch  : RHEL5-active

> ---------------------------------------------------------------
commit abfdb3994bd8f7bf155902681d5029e37666f6a4
Author: Jan Pokorný <jpokorny(a)redhat.com&gt;
Date:   Wed Aug 22 15:47:29 2012 +0200

    luci/MAINTAINERS.rst: add Brief intro into debugging
    
    Signed-off-by: Jan Pokorný <jpokorny(a)redhat.com&gt;


> ---------------------------------------------------------------
 luci/MAINTAINERS.rst |   33 +++++++++++++++++++++++++++++++++
 1 files changed, 33 insertions(+), 0 deletions(-)

diff --git a/luci/MAINTAINERS.rst b/luci/MAINTAINERS.rst
index 224efca..fec2019 100644
--- a/luci/MAINTAINERS.rst
+++ b/luci/MAINTAINERS.rst
@@ -3,6 +3,39 @@
 ============================================================
 
 
+Brief intro into debugging
+==========================
+
+This does not cover all possible scenarios, but is pretty generetic.
+
+1. install luci RPM
+2. run this to generate SSL key, etc.
+        # service luci start && service luci stop
+3. start stunnel to switch to HTTPS communication as usual
+   (note that, e.g., some cookies require secured communication)
+        # cat /var/lib/luci/etc/stunnel.conf | stunnel -fd 0
+4. finally, start the zope session
+        # LDIR=$(rpm --eval '%_libdir')
+        # export Z_DEBUG_MODE=1 PYTHONPATH=${LDIR}/luci/zope/lib/python
+        # export INSTANCE_HOME=/var/lib/luci SOFTWARE_HOME=${LDIR}/luci/zope/lib/python
+        # /usr/bin/python ${LDIR}/luci/zope/lib/python/Zope2/Startup/zopectl.py \
+          -C /var/lib/luci/etc/zope.conf
+5. enjoy the zope terminal interface, most probably you want "fg"
+        program: /var/lib/luci/bin/runzope
+        daemon manager not running
+        zopectl> fg
+   which is a foreground mode of the application throwing log messages
+   directly into the terminal; escape with Ctrl-C as usual
+
+Before step 4., you may want place debugger-activating "denotators"
+into respective code; for instance:
+
+        import pdb; pdb.set_trace()
+
+This way, the Python debugger will take the control when running into
+such points in the code.
+
+
 How to enable and access ZMI
 ============================