Troubleshooting EDuke32 - Revision history

Hendricks266: /* using the debugger */

2024-02-16T00:24:11Z

using the debugger

← Older revision		Revision as of 17:24, 15 February 2024
Line 93:		Line 93:
	bt		bt
	(backtrace) there. This will print out the location where the crash occurred and serve as a first diagnostic to the developers.		(backtrace) there. This will print out the location where the crash occurred and serve as a first diagnostic to the developers.

			If the program terminates mysteriously without a crash, you can try the following command and then run again:
			b exit

	===advanced debugging===		===advanced debugging===

Hendricks266: /* Debugging */

2024-02-16T00:22:09Z

Debugging

← Older revision		Revision as of 17:22, 15 February 2024
Line 63:		Line 63:
	To help the developers in tracking down crashes, you could try running a debug version of the executable under GDB, the GNU debugger, until the crash happens.		To help the developers in tracking down crashes, you could try running a debug version of the executable under GDB, the GNU debugger, until the crash happens.

	If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do ~~'''~~not~~'''~~ have to compile EDuke32 yourself, instead you just have to install the compiler.		If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do not have to compile EDuke32 yourself if you have a debug build already, instead you just have to install the compiler.

	===building with debug symbols===		===building with debug symbols===

Hendricks266: /* Debugging */

2023-12-05T01:34:17Z

Debugging

← Older revision		Revision as of 18:34, 4 December 2023
Line 64:		Line 64:

	If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do '''not''' have to compile EDuke32 yourself, instead you just have to install the compiler.		If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do '''not''' have to compile EDuke32 yourself, instead you just have to install the compiler.

			===building with debug symbols===

			If you are using a [https://dukeworld.duke4.net/eduke32/synthesis/ synthesis build] on Windows, use <code>*.debug.exe</code>

			If you are building from source, append <code>RELEASE=0</code> to your <code>make</code> invocation. If you have already built, you will need to <code>make clean</code> first.

	===running the debugger===		===running the debugger===

	To debug the program, ~~([http://dukeworld~~.~~duke4.net/eduke32/synthesis/ synthesis build recommended])~~ open a [[Working with the Windows Command Prompt#Opening A Command Prompt Window\|command prompt]] ~~or terminal window~~ and run this command, using Mapster32 as an example:		To debug the program, we will use GDB.

			On Windows, open a [[Working with the Windows Command Prompt#Opening A Command Prompt Window\|command prompt]] and run this command, using Mapster32 as an example:

	gdb --args mapster32.debug.exe ''[additional arguments...]''		gdb --args mapster32.debug.exe ''[additional arguments...]''

			On Linux, run this command from a terminal:

			gdb --args ./mapster32 ''[additional arguments...]''

			On macOS, use LLDB.

			lldb -- ./Mapster32.app ''[additional arguments...]''

			===using the debugger===
	and enter		and enter
	r		r

LeoD: added the need of backtrace DLL

2021-09-27T14:51:37Z

added the need of backtrace DLL

← Older revision		Revision as of 07:51, 27 September 2021
Line 30:		Line 30:
	==Crashes==		==Crashes==

	If you encounter an actual program crash, try running the debug executables (eduke32.debug.exe or mapster32.debug.exe) included in the EDuke32 builds available from [http://dukeworld.duke4.net/eduke32/synthesis/ synthesis]. If you encounter the crash again, look for a file named '''eduke32.crash.log''' or '''mapster32.crash.log''' and include it when following the directions in the [[#Basic Assistance\|Basic Assistance]] section.		If you encounter an actual program crash, try running the debug executables (eduke32.debug.exe or mapster32.debug.exe) included in the EDuke32 builds available from [http://dukeworld.duke4.net/eduke32/synthesis/ synthesis]. Put the according backtrace DLL (32/64 bit) alongside the debug executable. If you encounter the crash again, look for a file named '''eduke32.crash.log''' or '''mapster32.crash.log''' and include it when following the directions in the [[#Basic Assistance\|Basic Assistance]] section.

	If you cannot find this file, please proceed to the [[#Debugging\|Debugging]] section.		If you cannot find this file, please proceed to the [[#Debugging\|Debugging]] section.

Doom64hunter: /* Basic Assistance */ reference the gitlab issues page

2020-10-17T06:45:07Z

Basic Assistance: reference the gitlab issues page

← Older revision		Revision as of 23:45, 16 October 2020
Line 3:		Line 3:
	==Basic Assistance==		==Basic Assistance==

	If you have a problem with EDuke32 or Mapster32, [http://forums.duke4.net/forum/27-bug-reports-help-me-threads/ READ THE THREADS HERE FIRST] to see if anyone else has experienced the same issue. Do not post a new thread if ~~a thread for~~ a similar problem already ~~exists~~.		If you have a problem with EDuke32 or Mapster32, [http://forums.duke4.net/forum/27-bug-reports-help-me-threads/ READ THE THREADS HERE FIRST], as well as [https://voidpoint.io/terminx/eduke32/-/issues THE ISSUES PAGE ON THE GITLAB] to see if anyone else has experienced the same issue. Do not post a new thread or a new issue if a similar problem has already been reported.

	<font size="3" color="red">'''Always do a search for your problem before posting. Any new topics should clearly describe the problem in the title/summary.'''</font>		<font size="3" color="red">'''Always do a search for your problem before posting. Any new topics/issues should clearly describe the problem in the title/summary.'''</font>

	If you find no previous reports of your issue, prepare to submit a bug report to the forum. For general help, follow the instructions below in a new thread at the forum link above. For a problem with a particular TC or mod, it may be better to contact its author directly depending on the circumstances and the nature of the error.		If you find no previous reports of your issue, prepare to submit a bug report to the forum. For general help, follow the instructions below in a new thread at the forum link above. For a problem with a particular TC or mod, it may be better to contact its author directly depending on the circumstances and the nature of the error.

Hendricks266 at 21:25, 15 July 2014

2014-07-15T21:25:20Z

← Older revision		Revision as of 14:25, 15 July 2014
Line 30:		Line 30:
	==Crashes==		==Crashes==

	If you encounter an actual program crash, try running the debug executables (eduke32.debug.exe or mapster32.debug.exe) included in the EDuke32 builds available from [http://dukeworld.duke4.net/eduke32/synthesis/ synthesis]. If you encounter the crash again, look for a file named '''~~eduke32_or_mapster32~~.crash.log''' and include it when following the directions in the [[#Basic Assistance\|Basic Assistance]] section.		If you encounter an actual program crash, try running the debug executables (eduke32.debug.exe or mapster32.debug.exe) included in the EDuke32 builds available from [http://dukeworld.duke4.net/eduke32/synthesis/ synthesis]. If you encounter the crash again, look for a file named '''eduke32.crash.log''' or '''mapster32.crash.log''' and include it when following the directions in the [[#Basic Assistance\|Basic Assistance]] section.

	If you cannot find this file, please proceed to the [[#Debugging\|Debugging]] section.		If you cannot find this file, please proceed to the [[#Debugging\|Debugging]] section.

Hendricks266: /* Crashes */

2013-03-29T17:08:25Z

Crashes

← Older revision		Revision as of 10:08, 29 March 2013
Line 30:		Line 30:
	==Crashes==		==Crashes==

	If you encounter an actual program crash, try running the debug executables (eduke32.debug.exe or mapster32.debug.exe) included in the EDuke32 builds available from [http://dukeworld.duke4.net/eduke32/synthesis/ synthesis]. If you encounter the crash again, look for a file named '''eduke32_or_mapster32.~~crashlog~~''' and include it when following the directions in the [[#Basic Assistance\|Basic Assistance]] section.		If you encounter an actual program crash, try running the debug executables (eduke32.debug.exe or mapster32.debug.exe) included in the EDuke32 builds available from [http://dukeworld.duke4.net/eduke32/synthesis/ synthesis]. If you encounter the crash again, look for a file named '''eduke32_or_mapster32.crash.log''' and include it when following the directions in the [[#Basic Assistance\|Basic Assistance]] section.

	If you cannot find this file, please proceed to the [[#Debugging\|Debugging]] section.		If you cannot find this file, please proceed to the [[#Debugging\|Debugging]] section.

Hendricks266 at 20:38, 3 November 2012

2012-11-03T20:38:38Z

← Older revision		Revision as of 13:38, 3 November 2012
Line 11:		Line 11:
	<font size="4">'''Please add the following information to any bug report:'''</font>		<font size="4">'''Please add the following information to any bug report:'''</font>

	#You need to locate a file in your EDuke32 data called '''eduke32.log''' or '''mapster32.log''' depending on which program encountered the error. This file is overwritten every time the programs are run, so it is vital that the log file comes from an occasion when you encountered the problem and have not run the program again afterwards. Any log files should be posted as attachments or loaded on to http://pastebin.com/. '''Absolutely do NOT post logs as part of your post text itself!'''		#You need to locate a file in your EDuke32 data called '''eduke32.log''' or '''mapster32.log''' depending on which program encountered the error. This file is overwritten every time the programs are run, so it is vital that the log file comes from an occasion when you encountered the problem and have not run the program again afterwards. Any log files should be posted as attachments or loaded on to http://pastebin.com/. <font color="red">'''Absolutely do NOT post logs as part of your post text itself!'''</font>
	#Your system specifications (OS, GPU, CPU, etc) may be helpful, especially with OpenGL graphics- or performance-related reports. [http://www.cpuid.com/softwares/cpu-z.html CPUID CPU-Z] is useful for details.		#Your system specifications (OS, GPU, CPU, etc) may be helpful, especially with OpenGL graphics- or performance-related reports. [http://www.cpuid.com/softwares/cpu-z.html CPUID CPU-Z] is useful for details.
	#What version of EDuke32 you are running.		#What version of EDuke32 you are running.
Line 19:		Line 19:

	===tips for quicker bug handling===		===tips for quicker bug handling===

			The following points will help us and help you find solutions '''much more quickly and effectively''', which should be in the interest of all parties involved.

	* '''When in doubt whether a log is useful or not, attach it regardless.''' This means that time can be spent on actually fixing the bug instead of asking for the log and waiting... and waiting... and waiting...		* '''When in doubt whether a log is useful or not, attach it regardless.''' This means that time can be spent on actually fixing the bug instead of asking for the log and waiting... and waiting... and waiting...
	* '''Show, don't merely tell.''' For example, if it is an editor bug, attach a small test map with the bug report or PM it in case you don't want it to be public.		* '''Show, don't merely tell.''' For example, if it is an editor bug, attach a small test map with the bug report or PM it in case you don't want it to be public.
			* When reporting a bug for the first time, '''assume that you're the first to encounter it''', that is, don't leave out details just because you think they're "well known".
	* '''Assume vanilla Duke unless known otherwise.''' For example, if developing a new mod containing new art and reporting an editor or game effect bug, load the map in a vanilla installation and replace all now-void tiles using [']+[F] -> replace invalid tiles. Similarly, when filing a CON bug, try to present it such that it can be loaded as a stand-alone module (-mx switch to EDuke32). Of course, for released mods, it's OK to do otherwise if it's known that the developer(s) have that particular mod installed.		* '''Assume vanilla Duke unless known otherwise.''' For example, if developing a new mod containing new art and reporting an editor or game effect bug, load the map in a vanilla installation and replace all now-void tiles using [']+[F] -> replace invalid tiles. Similarly, when filing a CON bug, try to present it such that it can be loaded as a stand-alone module (-mx switch to EDuke32). Of course, for released mods, it's OK to do otherwise if it's known that the developer(s) have that particular mod installed.
	* When reporting a bug for the first time, '''assume that you're the first to encounter it''', that is, don't leave out details just because you think they're "well known"
	* When referring to locations in a map, don't assume that the developers have played them unless it's a vanilla map or a classic "must play" plain user map (what constitutes such a map is somewhat subjective, of course). Instead, '''provide coordinates for the location''', obtainable by pressing LShift in Mapster32, or with the DNCOORDS cheat in the game. Feel free to round the numbers for prettier appearance, as long as it's reasonably clear what place is meant.		* When referring to locations in a map, don't assume that the developers have played them unless it's a vanilla map or a classic "must play" plain user map (what constitutes such a map is somewhat subjective, of course). Instead, '''provide coordinates for the location''', obtainable by pressing LShift in Mapster32, or with the DNCOORDS cheat in the game. Feel free to round the numbers for prettier appearance, as long as it's reasonably clear what place is meant.


	~~This will help us and help you find solutions '''much more quickly and effectively''', which should be in the interest of all parties involved.~~

	==Crashes==		==Crashes==
Line 64:		Line 64:

	If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do '''not''' have to compile EDuke32 yourself, instead you just have to install the compiler.		If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do '''not''' have to compile EDuke32 yourself, instead you just have to install the compiler.

			===running the debugger===

	To debug the program, ([http://dukeworld.duke4.net/eduke32/synthesis/ synthesis build recommended]) open a [[Working with the Windows Command Prompt#Opening A Command Prompt Window\|command prompt]] or terminal window and run this command, using Mapster32 as an example:		To debug the program, ([http://dukeworld.duke4.net/eduke32/synthesis/ synthesis build recommended]) open a [[Working with the Windows Command Prompt#Opening A Command Prompt Window\|command prompt]] or terminal window and run this command, using Mapster32 as an example:
Line 72:		Line 74:
	bt		bt
	(backtrace) there. This will print out the location where the crash occurred and serve as a first diagnostic to the developers.		(backtrace) there. This will print out the location where the crash occurred and serve as a first diagnostic to the developers.

			===advanced debugging===

			There are specific circumstances where you can use [http://sourceware.org/gdb/onlinedocs/gdb/Set-Breaks.html breakpoints] and [http://sourceware.org/gdb/onlinedocs/gdb/Set-Watchpoints.html watchpoints] if you know where they would be applicable.

			===submitting the output===

	[[Working with the Windows Command Prompt#How to Copy and Paste Text\|Copy and paste the output gdb displays]] and send it to the developers so they can work on a fix. [http://www.pastebin.com Pastebin.com] is useful for this purpose.		[[Working with the Windows Command Prompt#How to Copy and Paste Text\|Copy and paste the output gdb displays]] and send it to the developers so they can work on a fix. [http://www.pastebin.com Pastebin.com] is useful for this purpose.

Helixhorned: /* tips for quicker bug handling */ more boldness

2012-07-27T16:29:23Z

tips for quicker bug handling: more boldness

← Older revision		Revision as of 09:29, 27 July 2012
Line 26:		Line 26:


	This will help us and help you find solutions ~~much~~ '''more quickly and effectively''', which should be in the interest of all parties involved.		This will help us and help you find solutions '''much more quickly and effectively''', which should be in the interest of all parties involved.

	==Crashes==		==Crashes==

Helixhorned: /* Debugging */ that reference to randomly-occuring bugs was rather weird

2012-07-27T16:28:23Z

Debugging: that reference to randomly-occuring bugs was rather weird

← Older revision		Revision as of 09:28, 27 July 2012
Line 61:		Line 61:

	==Debugging==		==Debugging==
	~~The most insidious types of bugs are those that occur randomly and with no apparent pattern.~~ To help the developers in tracking down ''crashes~~'' happening this way~~, you could try running a debug version of the executable under GDB, the GNU debugger, until the crash happens.		To help the developers in tracking down crashes, you could try running a debug version of the executable under GDB, the GNU debugger, until the crash happens.

	If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do '''not''' have to compile EDuke32 yourself, instead you just have to install the compiler.		If you are running Windows and do not already have GDB set up, follow the instructions to set up [[Building EDuke32 on Windows]] and it will be included. You do '''not''' have to compile EDuke32 yourself, instead you just have to install the compiler.