Debugging Gramps - Revision history

Bmcage at 07:44, 7 June 2013

2013-06-07T07:44:30Z

Romjerome: /* Use profiling */

2013-03-26T14:23:54Z

‎Use profiling

Bmcage: /* Use gdb C debugger */

2013-02-01T19:05:51Z

‎Use gdb C debugger

Patsyblefebre: formating

2013-02-01T03:07:34Z

formating

Patsyblefebre: /* Use gdb C debugger */ introspection

2013-02-01T03:05:44Z

‎Use gdb C debugger: introspection

Patsyblefebre: Gramps

2013-01-16T23:10:02Z

Gramps

Patsyblefebre: Patsyblefebre moved page Debugging GRAMPS to Debugging Gramps: lower case

2013-01-16T23:04:11Z

Patsyblefebre moved page Debugging GRAMPS to Debugging Gramps: lower case

Patsyblefebre: /* Use gdb C debugger */

2012-12-26T21:55:11Z

‎Use gdb C debugger: <pre>

Gioto: /* Use the winpdb python debugger */

2011-10-18T22:23:16Z

‎Use the winpdb python debugger

Daleathan at 02:14, 28 September 2011

2011-09-28T02:14:56Z

← Older revision		Revision as of 07:44, 7 June 2013
Line 131:		Line 131:

	to get a backtrace of the C stack showing where the message originated and what called the function, etc.		to get a backtrace of the C stack showing where the message originated and what called the function, etc.
		+
		+	You can force a hard crash on warnings by setting G_DEBUG.
		+
		+	For example:
		+	LC_ALL=C G_DEBUG=fatal-warnings python -m trace -t Gramps.py
		+
		+	Different values possible: [https://developer.gnome.org/glib/2.34/glib-running.html]

	=== Learn More ===		=== Learn More ===

← Older revision		Revision as of 14:23, 26 March 2013
Line 58:		Line 58:

	That's it		That's it
		+
		+	See also [[GEPS_016:_Enhancing_GRAMPS_Processing_Speed]] for a sample of Profile Analysis.

	== Use the winpdb python debugger ==		== Use the winpdb python debugger ==

@@ Line 77: / Line 77: @@
 With GObject introspection, much more can go wrong on a lower level, causing C errors. For these gdb can be used. You should install some debug libraries like libglib2.0-0-dbg, python-gobject-dbg, ... .
-Then, you start in a terminal gdb in the directory where gramps.py is stored with
+Then, you start in a terminal gdb in the directory where Gramps.py is stored with
   gdb python
@@ Line 100: / Line 100: @@
 You just type now:
-  run gramps.py
+  run Gramps.py
 and then navigate gramps to the segmentation fault. After that, you see something like
@@ Line 113: / Line 113: @@
 which will print the backtrace. You are now ready to use your C knowledge to fix the bug!
 [[Category:Developers/Reference]]
 [[Category:Developers/Tutorials]]
 [[Category:Developers/General]]

@@ Line 29: / Line 29: @@
 Short: in your code add data to the logger with: log.warning(), log.error(), log.info()...
 Start Gramps with the --debug flag: python gramps.py --debug="name_of_the_logger"
@@ Line 52: / Line 53: @@
          profile(self.save, *obj)
-Then run GRAMPS, every time you save, the profiler kicks in and prints to command line a report with the time for each function.
+Then run Gramps, every time you save, the profiler kicks in and prints to command line a report with the time for each function.
 So in short: replace the call to a function/method to calling profile with as first parameter the function/method, and other parameters the parameters of the function/method.
@@ Line 66: / Line 67: @@
   winpdb src/gramps.py
-[[Image:Winpdb.png|thumb|Winpdb with GRAMPS loaded]] Now, in File menu, select 'Open Source', and open the source file you want to debug. Now all debug options are possible. Eg, go to a line in the file with the cursor, and click the ''run to line'' button. The debugger will run to that point, and left show you all defined local variables with their value, as well as the stack frame.
+[[Image:Winpdb.png|thumb|Winpdb with Gramps loaded]]
 Try it!
@@ Line 73: / Line 76: @@
 With GObject introspection, much more can go wrong on a lower level, causing C errors. For these gdb can be used. You should install some debug libraries like libglib2.0-0-dbg, python-gobject-dbg, ... .
 Then, you start in a terminal gdb in the directory where gramps.py is stored with

@@ Line 72: / Line 72: @@
 == Use gdb C debugger ==
-With GObject introscpection, much more can go wrong on a lower level, causing C errors. For these gdb can be used. You should install some debug libraries like libglib2.0-0-dbg, python-gobject-dbg, ... .
+With GObject introspection, much more can go wrong on a lower level, causing C errors. For these gdb can be used. You should install some debug libraries like libglib2.0-0-dbg, python-gobject-dbg, ... .
 Then, you start in a terminal gdb in the directory where gramps.py is stored with

@@ Line 1: / Line 1: @@
-An overview on how to debug GRAMPS.
+An overview on how to debug Gramps.
 == Hard crash ==
-When a hard crash occurs, you typically have no idea where the crash occurs. It is important to know the line where the crash occurs. So if you are able to reproduce the crash, restart GRAMPS with the command:
+When a hard crash occurs, you typically have no idea where the crash occurs. It is important to know the line where the crash occurs. So if you are able to reproduce the crash, restart Gramps with the command:
   python -m trace -t src/gramps.py
@@ Line 13: / Line 13: @@
 == Add debug statements ==
-GRAMPS is run with the optimize flag.
+Gramps is run with the optimize flag.
   python -O gramps.py
-This gives you the option of adding debug statements. You can use the __debug__ variable or the assert statement for this. This allows us to add code to GRAMPS that will be printed out when GRAMPS runs without the optimize flag:
+This gives you the option of adding debug statements. You can use the __debug__ variable or the assert statement for this. This allows us to add code to Gramps that will be printed out when Gramps runs without the optimize flag:
   python gramps.py
@@ Line 24: / Line 24: @@
 == Use the log infrastructure ==
-GRAMPS has built in the python log infratructure. GRAMPS runs with logging level logging.DEBUG to stderrh.
+Gramps has built in the python log infratructure. Gramps runs with logging level logging.DEBUG to stderrh.
 More info: [[Logging system]]
 Short: in your code add data to the logger with: log.warning(), log.error(), log.info()...
-Start GRAMPS with the --debug flag: python gramps.py --debug="name_of_the_logger"
+Start Gramps with the --debug flag: python gramps.py --debug="name_of_the_logger"
 This is useful when working in different parts, adding info output, and selecting on the command line with --debug the logger you want to see output with.
 == Use profiling ==
-GRAMPS has a convenience hook to allow you to do profiling. Profiling gives an overview how many times methods are called in a code fragment and how long each one took. It helps to find performance bottlenecks.
+Gramps has a convenience hook to allow you to do profiling. Profiling gives an overview how many times methods are called in a code fragment and how long each one took. It helps to find performance bottlenecks.
 An example usage:

@@ Line 79: / Line 79: @@
 You should see something like:
   GNU gdb (Ubuntu/Linaro 7.2-1ubuntu11) 7.2
   Copyright (C) 2010 Free Software Foundation, Inc.
@@ Line 91: / Line 92: @@
   done.
   (gdb)
 You just type now:

@@ Line 59: / Line 59: @@
 == Use the winpdb python debugger ==
-'''Note''': there are some issues with the winpdb debugger. For a workaround see bug ticket: [http://www.gramps-project.org/bugs/view.php?id=2564 2564]
+'''Note''': there are some issues with the winpdb debugger. For a workaround see bug ticket: {{bug|2564}}
 [http://winpdb.org/ Winpdb] (Ubuntu: sudo apt-get install winpdb) is a graphical interface for the python debugger.

← Older revision		Revision as of 02:14, 28 September 2011
Line 1:		Line 1:
−	~~This page gives an~~ overview on how to debug GRAMPS.	+	An overview on how to debug GRAMPS.

	== Hard crash ==		== Hard crash ==