Documentation/Nightly/Developers/Tutorials/Debug Instructions - Revision history

Lasso: Moved to readthedocs

2021-08-19T04:36:01Z

Moved to readthedocs

Show changes

Lasso: /* Linux */

2020-03-18T03:36:06Z

Linux

Lasso: /* Using Visual Studio */

2020-01-09T17:04:37Z

Using Visual Studio

JChris.FillionR: /* Using Visual Studio */

2019-11-29T13:51:04Z

Using Visual Studio

JChris.FillionR: /* Using Visual Studio */

2019-11-29T13:50:03Z

Using Visual Studio

JChris.FillionR at 15:14, 25 June 2019

2019-06-25T15:14:16Z

Smrolfe: /* Using Visual Studio */

2019-01-30T17:28:27Z

Using Visual Studio

Smrolfe: /* Using Visual Studio */ Suggest removing this note as the issue referred to is closed

2019-01-30T17:16:10Z

Using Visual Studio: Suggest removing this note as the issue referred to is closed

Phcerdan: /* Analyze a segmentation fault */

2018-05-28T16:29:46Z

Analyze a segmentation fault

JChris.FillionR: /* Using Visual Studio */

2017-08-24T15:40:16Z

Using Visual Studio

@@ Line 45: / Line 45: @@
 To decompress the coredump file to use with other IDE or ddd, change the coredump.conf Compress option, or use:
    coredumpctl dump $PID > /tmp/corefile
 ===GDB debug by attaching to running process [RECOMMENDED]===
 <ol start="1" style="list-style-type: decimal;">
@@ Line 92: / Line 85: @@
 </ol>
 ===GDB debug by using exec-wrapper===

@@ Line 52: / Line 52: @@
 *<code>--gdb</code>: runs GDB then executes SlicerQT-real from within the debugger environment.
-===GDB debug by attaching to running process [RECOMMENDED] ===
+===GDB debug by attaching to running process [RECOMMENDED]===
@@ Line 84: / Line 83: @@
    <pre>$ gdb --pid $PIDABOVE</pre>
 </li>
 <li>
@@ Line 99: / Line 97: @@
 The general idea of the wrapper is to set all of the appropriate environment variables as they would be set by the app launcher. From SlicerLauncherSettings:
 *[LibraryPath] contents should be in LD_LIBRARY_PATH
 *[Paths] contents should be in PATH
@@ Line 127: / Line 126: @@
 See [[Documentation/{{documentation/version}}/Developers/Tutorials/QtCreator|QtCreator page]] for instructions.
-== Windows ==
+==Windows==
-=== Using Visual Studio ===
+===Using Visual Studio===
-For VisualStudio it's also possible to run the IDE with the correct environment to debug slicer.
+For VisualStudio it's also possible to run the IDE with the correct environment to debug Slicer.
-* Start VisualStudio by using the launcher. Run: <code>Slicer.exe --VisualStudioProject</code>
+*Start VisualStudio by using the launcher. Run: <code>Slicer.exe --VisualStudioProject</code>
-** If you use non-supported VisualStudio version (e.g., VS2010, VS2012, ...) then you may have to start the executable of the VisualStudio IDE manually with the --launch option, for example: <code>Slicer.exe --launch "c:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"</code>
+**If you use non-supported VisualStudio version (e.g., VS2010, VS2012, ...) then you may have to start the executable of the VisualStudio IDE manually with the --launch option, for example: <code>Slicer.exe --launch "c:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"</code>
 <!--
 * When Visual Studio is started, open the <code>...\Slicer-build\Slicer.sln</code> solution (note that this is not the first level <code>...\Slicer_sln</code> )
 -->
-* Expand App-Slicer and set the <b>SlicerApp</b> as StartUp project (right-click on SlicerApp project and select "Set as StartUp Project", make sure to select <b>SlicerApp</b> and <b>NOT qSlicerApp</b>)
+*Expand App-Slicer and set the <b>SlicerApp</b> as StartUp project (right-click on SlicerApp project and select "Set as StartUp Project", make sure to select <b>SlicerApp</b> and <b>NOT qSlicerApp</b>)
-* Run Slicer in debug mode by Start Debugging command (in Debug menu).
+**To debug in an extension's solution: set ALL_BUILD project as StartUp project and in project settings, set Debugging / Command field to the full path of SlicerApp-real.exe - something like <code>...\Slicer-build\bin\Debug\SlicerApp-real.exe</code>
 Note that because CMake re-creates the solution file from within the build process, Visual Studio will sometimes need to stop and reload the project, requiring manual button pressing on your part (just press Yes or OK whenever you are asked).  To avoid this, you can use a script to complete the build process and then re-start the Visual Studio.
@@ Line 146: / Line 148: @@
 See [[Documentation/{{documentation/version}}/Developers/Tutorials/QtCreator|QtCreator page]] for instructions.
-=== Using shell scripts for building/re-building Slicer ===
+===Using shell scripts for building/re-building Slicer===
-==== Using batch (.bat) files ====
+====Using batch (.bat) files====
 Copy-paste the content below into a file called ''BuildSlicer.bat'' and run it to build or re-build Slicer. Check and if necessary update the first few lines with the actual location of source code and tools on your computer.
@@ Line 165: / Line 167: @@
 </pre>
-==== Experimental: Using Cygwin ====
+====Experimental: Using Cygwin====
 If you use cygwin, you can create simple shell scripts, for example in /usr/local/bin, which these several steps at once when run from the Slicer4-superbuild directory:
-* ''s4build'' (slicer4 build)
+*''s4build'' (slicer4 build)
   (cd Slicer-build; cmake.exe -VV --debug-output . && ./Slicer.exe --VisualStudio Slicer.sln /out buildlog.txt /build)
   (cd Slicer-build; ./Slicer.exe --VisualStudio Slicer.sln)
 * ''s4sbuild'' (slicer4 super build)
   (cmake.exe -VV --debug-output . && ./Slicer-build/Slicer.exe --VisualStudio Slicer.sln /out buildlog.txt /build)
   (cd Slicer-build; ./Slicer.exe --VisualStudio Slicer.sln)
@@ Line 181: / Line 186: @@
 Note the buildlog.txt files for checking if anything went wrong.
-== Mac (Xcode) ==
+==Mac (Xcode)==
 ===Using Xcode===
@@ Line 191: / Line 196: @@
 ''Note: You need to set up a dummy project in Xcode just to enable some of the options.''  This means that Xcode will create a MacOS code template, but you won't use it directly (instead you will point to the code you build with cmake/make).
-==== Attaching to a running process ====
+====Attaching to a running process====
 You can use the Attach to Process option in the Xcode Product menu for debugging.  This will allow you to get browsable stack traces for crashes.
 Steps:
 # Start Slicer
-# Start Xcode
+#Start Slicer
-# Use the Product->Attach to Process... menu
+#Start Xcode
 ====Setting Breakpoints====
@@ Line 214: / Line 220: @@
 Since you are using a dummy project but want to debug the slicer application, you need to do the following:
 # Start Xcode and open dummy project
-# Pick Product->Edit Scheme...
+#Start Xcode and open dummy project
-# Select the Run section
+#Pick Product->Edit Scheme...
-# Select the Info tab
+#Select the Run section
-# Pick Slicer.app as the Executable
+#Select the Info tab
-# Click OK
+#Pick Slicer.app as the Executable
-# Now the Run button will start Slicer for debugging
+#Click OK
 Note that you can create multiple schemes, each various command line options to pass to slicer so you can easily get back to a debugging environment.
@@ Line 233: / Line 240: @@
 Once VisualStudio is open with the Slicer environment loaded, it is possible to run and debug tests.
 To run all tests, build the ''RUN_TESTS'' project.
 #To debug a test, find its project:
 ##Libs/MRML/Core tests are in the ''MRMLCoreCxxTests'' project
 ##CLI tests are in ''CLI_NAMETest'' project (e.g. ThresholdScalarVolumeTest)
 ##Loadable module tests are in ''qSlicerLOADABLE_NAMECxxTests'' project (e.g. qSlicerVolumeRenderingCxxTests)
 ##Module logic tests are in ''MODULE_NAMELogicCxxTests'' project (e.g. VolumeRenderingLogicCxxTests)
 ##Module widgets tests are in ''MODULE_NAMEWidgetsCxxTests'' project (e.g. VolumesWidgetsCxxTests)
 #Go to the project debugging properties (right click -> Properties, then Configuration Properties/Debugging)
 #In ''Command Arguments'', type the name of the test (e.g. <code>vtkMRMLSceneImportTest</code> for project MRMLCoreCxxTests)
-# If the test takes argument(s), enter the argument(s) after the test name in ''Command Arguments'' (e.g. <code>vtkMRMLSceneImportTest C:\Path\To\Slicer4\Libs\MRML\Core\Testing\vol_and_cube.mrml</code>)
+#If the test takes argument(s), enter the argument(s) after the test name in ''Command Arguments'' (e.g. <code>vtkMRMLSceneImportTest C:\Path\To\Slicer4\Libs\MRML\Core\Testing\vol_and_cube.mrml</code>)
-## You can see what arguments are passed by the dashboards by looking at the test details in [http://slicer.cdash.org/index.php?project=Slicer4 CDash].
+##You can see what arguments are passed by the dashboards by looking at the test details in [http://slicer.cdash.org/index.php?project=Slicer4 CDash].
-## Most VTK and Qt tests support the <code>-I</code> argument, it allows the test to be run in "interactive" mode. It doesn't exit at the end of the test.
+##Most VTK and Qt tests support the <code>-I</code> argument, it allows the test to be run in "interactive" mode. It doesn't exit at the end of the test.
-# Make the project ''Set As StartUp Project''
+#Make the project ''Set As StartUp Project''
-# ''Start Debugging (F5)''
+#''Start Debugging (F5)''
 ==Debugging Python scripts==

@@ Line 135: / Line 135: @@
 * Start VisualStudio by using the launcher. Run: <code>Slicer.exe --VisualStudioProject</code>
 ** If you use non-supported VisualStudio version (e.g., VS2010, VS2012, ...) then you may have to start the executable of the VisualStudio IDE manually with the --launch option, for example: <code>Slicer.exe --launch "c:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"</code>
 * When Visual Studio is started, open the <code>...\Slicer-build\Slicer.sln</code> solution (note that this is not the first level <code>...\Slicer_sln</code> )
 * Expand App-Slicer and set the <b>SlicerApp</b> as StartUp project (right-click on SlicerApp project and select "Set as StartUp Project", make sure to select <b>SlicerApp</b> and <b>NOT qSlicerApp</b>)
 * Run Slicer in debug mode by Start Debugging command (in Debug menu).

@@ Line 133: / Line 133: @@
 For VisualStudio it's also possible to run the IDE with the correct environment to debug slicer.
-* Start VisualStudio by using the launcher. Run: <code>Slicer.exe --VisualStudio</code>
+* Start VisualStudio by using the launcher. Run: <code>Slicer.exe --VisualStudioProject</code>
 ** If you use non-supported VisualStudio version (e.g., VS2010, VS2012, ...) then you may have to start the executable of the VisualStudio IDE manually with the --launch option, for example: <code>Slicer.exe --launch "c:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"</code>
 * When Visual Studio is started, open the <code>...\Slicer-build\Slicer.sln</code> solution (note that this is not the first level <code>...\Slicer_sln</code> )

@@ Line 136: / Line 136: @@
 ** If you use non-supported VisualStudio version (e.g., VS2010, VS2012, ...) then you may have to start the executable of the VisualStudio IDE manually with the --launch option, for example: <code>Slicer.exe --launch "c:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"</code>
 * When Visual Studio is started, open the <code>...\Slicer-build\Slicer.sln</code> solution (note that this is not the first level <code>...\Slicer_sln</code> )
-* Expand App-Slicer and set the SlicerApp as StartUp project (right-click on SlicerApp project and select "Set as StartUp Project")
+* Expand App-Slicer and set the <b>SlicerApp</b> as StartUp project (right-click on SlicerApp project and select "Set as StartUp Project", make sure to select <b>SlicerApp</b> and <b>NOT qSlicerApp</b>)
 * Run Slicer in debug mode by Start Debugging command (in Debug menu).

← Older revision		Revision as of 17:16, 30 January 2019
Line 130:		Line 130:

	=== Using Visual Studio ===		=== Using Visual Studio ===
−
−	~~Note: SimpleITK has to be disabled for building in debug mode. See more information at http://www.na-mic.org/Bug/view.php?id=3816 .~~

	For VisualStudio it's also possible to run the IDE with the correct environment to debug slicer.		For VisualStudio it's also possible to run the IDE with the correct environment to debug slicer.

@@ Line 13: / Line 13: @@
   (gdb) backtrace
   ...
 ===GDB debug with launch arguments===