[Xfce4-commits] <postler:master> Add an INSTALL file for installing and debugging

[Christian Dywan]

Updating branch refs/heads/master
         to 15ebca0210e139640b40de8672eae8f61a169c97 (commit)
       from 1ea5fff3cc34a73400e15b6a8dd5ab0f0edab84c (commit)

commit 15ebca0210e139640b40de8672eae8f61a169c97
Author: Christian Dywan <christian at twotoasts.de>
Date:   Mon Jan 17 21:41:19 2011 +0100

    Add an INSTALL file for installing and debugging
    
    Fixes: https://bugs.launchpad.net/postler/+bug/681677

 INSTALL |   68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 68 insertions(+), 0 deletions(-)

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..12927ac
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,68 @@
+This file is licensed under the terms of the LGPL 2.1, see the file COPYING.
+
++++ Installing Postler +++
+
+Building and installing Postler is straightforward.
+
+Make sure you have Python 2.4 or higher installed.
+
+Change to the Postler folder on your hard disk in a terminal.
+
+Run './waf configure'
+
+Run './waf build'
+
+You can now run Postler from the build folder, no installing needed
+
+'./waf build --run'
+
+You can install it like this
+
+'./waf install'
+
+If you need to do a clean rebuild, you can do either './waf clean'
+in order to remove binaries or './waf distclean' to also delete generated
+configuration files.
+
+For further options run './waf --help'
+
++++ Debugging Postler +++
+
+Debugging symbols are always included unless explicitly disabled.
+
+You can enable additional warnings if you intend to test patches
+
+'./waf configure -d full'
+
+Build with './waf build'
+
+For extra console output that may help identifying problems, do
+
+export POSTLER_DEBUG=1
+
+Make sure you have installed 'gdb', the GNU Debugger.
+
+Run Postler as
+
+'gdb --args _build_/default/postler/postler'
+
+or with parameters to test the composer
+
+'gdb --args _build_/default/postler/postler "foo at bar.com?subject=Greetings"'
+
+Inside gdb, type 'run'.
+
+Try to reproduce a crash that you experienced earlier,
+this time Postler will freeze at the point of the crash.
+Switch to your terminal, type bt ('backtrace') and hit Return.
+What you obtained now is a backtrace that should include
+function names and line numbers.
+
+If the problem is a warning and not a crash, try this:
+
+'G_DEBUG=all gdb _build_/default/postler/postler'
+
+For further information a tutorial for gdb and reading up on
+how you can install debugging symbols for libraries such as GLib,
+GTK+ and WebKitGTK+ are recommended.
+