mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-04-22 22:22:11 +02:00
c94b40cf94
Change-Id: I8cda245f8bc34b21e3088de561442982b86f05ef Reviewed-on: https://git.eclipse.org/r/30540 Tested-by: Hudson CI Reviewed-by: Jeff Johnston <jjohnstn@redhat.com> Tested-by: Jeff Johnston <jjohnstn@redhat.com>
102 lines
No EOL
6.8 KiB
HTML
102 lines
No EOL
6.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Starting The Debugger</title>
|
|
<link rel="stylesheet" type="text/css" href="../help.css">
|
|
</head>
|
|
<body>
|
|
<div role="main">
|
|
|
|
<h1>Starting The Debugger</h2>
|
|
|
|
<p>The debugger is started from the command-line using the <strong>cdtdebug.sh</strong> script.
|
|
The script contains the command-line needed to start Eclipse and to pass appropriate
|
|
parameters at start-up. The following are the command-line options supported:
|
|
|
|
<h4>-a</h4>
|
|
<p>This option specifies that you want to attach and debug an existing executable that is running on your system.
|
|
The option will bring up a dialog which contains a list of current executables running and you may choose the
|
|
executable(s) you wish to attach to. You also have the option of starting a new executable, if desired, but you
|
|
cannot specify a build log using this method.
|
|
|
|
<h4>-b <build log></h4>
|
|
<p>This option specifies an optional build log to use for indexing the source. The build log
|
|
is simply the output of a makefile build where the options used to compile the various source files
|
|
are displayed. The indexer uses these options to figure out what flags and include paths were used
|
|
and thus can properly parse the code to match the executable. The parsed tree is used to navigate
|
|
within the code to search for C/C++ elements or to calculate a call hierarchy. If this log is
|
|
not provided, the Stand-alone Debugger has only the compiler built-ins and default include paths
|
|
to use which means it may not search properly.</p>
|
|
|
|
<h4>-c <core file></h4>
|
|
<p>This option specifies a path to a core file to debug for an executable. The core file should have been created
|
|
by the specified executable. The executable is specified using the -e option, which is later described.
|
|
If the core file is invalid or no valid executable is also specified, a dialog will be brought up to allow
|
|
you to enter the required information.</p>
|
|
|
|
<h4>-e <executable> [args*]</h4>
|
|
<p>This option specifies a path to an executable to be debugged. If the -c option is previously specified,
|
|
the executable will be used in conjunction with the core file specified by the -c option. If the -c option is
|
|
not used, then any additional arguments on the command line will be passed to the <strong>main</strong> method
|
|
of the C/C++ application when it is debugged. If you do not specify any of the -a, -c, or -e options (e.g. starting up the Stand-alone Debugger
|
|
with no arguments), the last valid executable used invoking the debugger (if this isn't the first invocation)
|
|
will be offered to you via a dialog, which includes the original program arguments and build log.
|
|
You then have the choice of simply hitting the OK button to debug the last executable again or to change the arguments
|
|
as desired. If the executable location you specify is invalid or no executable is specified and no previous executable exists,
|
|
a dialog will be brought up to allow you to enter the required information. The dialog will be appropriate to whether
|
|
you have selected to debug a core file (-c specified) or not.</p>
|
|
|
|
<h2>Automated Set-up</h3>
|
|
|
|
<p>As mentioned, the Stand-alone Debugger will initialize Eclipse objects on your behalf on
|
|
start-up so you can immediately start debugging. For starters, the executable you specify
|
|
is imported on your behalf into an Eclipse
|
|
C/C++ project within the Workspace. An Eclipse project is a virtual container object that contains folders, files, etc. and has a particular
|
|
nature. Folders and files may be virtual and may actually link to objects outside of the workspace. In this particular
|
|
case, the debug info of the executable specified is used to determine the location of the source files. Each source
|
|
file is imported in the project, virtually, via a link. This is done so that the C/C++ indexer, which usually works on
|
|
a project being developed within Eclipse, has access to all code when it is parsing. Usually, the name of the default C/C++ project
|
|
will be <strong>Executables</strong>, the default project for importing executables into the CDT via the <strong>Executables</strong> view.
|
|
<p>The nature of a project determines what menus, actions, and views are valid for that project.
|
|
Menus, actions, and views that are not valid are not made visible.
|
|
This helps to remove the clutter of all contributed plug-ins to what is pertinent to the task at hand
|
|
(e.g. if the C/C++ and Java IDE plug-ins are both present, one does not want to see Java tasks when
|
|
working on a C/C++ project). Many of the plug-ins being used in the Stand-alone debugger only
|
|
work on C/C++ projects anyway.</p>
|
|
<p>Another Eclipse concept is the Perspective. An Eclipse perspective defines the set of views and how they are placed in the
|
|
main Eclipse Window. A perspective will have a default layout associated with it which can be modified and saved by the end-user for
|
|
future reference (e.g. adding or removing
|
|
views). For the purposes of debugging,
|
|
the Debug Perspective is the appropriate perspective to use and therefore the Stand-alone Debugger opens the Debug Perspective automatically for
|
|
you. The perspective has all the various views needed to debug your program.</p>
|
|
<p>To debug an executable, one needs to launch it via the debugger and to provide options both for the executable and the
|
|
debugger (in this case, GDB). All the information required to launch and debug is stored
|
|
in an Eclipse object known as a Launch Configuration. Various plug-ins can contribute different forms of Launch Configuration
|
|
which can in turn provide UI elements for settings. In the case of the Stand-alone Debugger, debugging an executable
|
|
results in the automatic creation of a C/C++ Local Application Launch configuration. This type of launch is meant
|
|
for launching an executable that is local to the current host. Additional parameters are available via the Launch Configuration
|
|
View such as gdb settings (e.g. gdb path, reverse debugging) and environment variables.</p>
|
|
|
|
<h2>Initial Debugger Layout</h3>
|
|
|
|
<p><img img src="../images/standalone_debugger.png" alt="Stand-alone Debugger"></p>
|
|
|
|
<p><img style="border: 0px solid ; width: 143px; height: 21px;"
|
|
src="../images/ngconcepts.gif" alt="Related concepts"> <br>
|
|
<a href="../concepts/cdt_c_over_cdt.htm">CDT Overview</a><br>
|
|
<a href="../concepts/cdt_c_projects.htm">C/C++ Projects</a><br>
|
|
<a href="../concepts/cdt_c_perspectives.htm">C/C++ Perspectives</a><br>
|
|
<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>
|
|
<a href="../concepts/cdt_c_search.htm">C/C++ Search</a></p>
|
|
<p><img src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
|
|
<br>
|
|
<a href="../reference/cdt_o_views.htm">Views</a><br>
|
|
<img src="../images/intl_07.gif" ALT="Intel Copyright Statement" >
|
|
|
|
</div>
|
|
</body>
|
|
|
|
</html> |