[anjuta] Reviewed Debugger documentation
- From: Sebastien Granjoux <sgranjoux src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [anjuta] Reviewed Debugger documentation
- Date: Wed, 24 Aug 2011 19:25:58 +0000 (UTC)
commit c24f90d56e9215654fdd51f2d1914b1de50f94b1
Author: P. F. Chimento <philip chimento gmail com>
Date: Sun Aug 7 14:09:39 2011 +0200
Reviewed Debugger documentation
This is a review of commit [b64286].
- In 'Debug Breakpoint', added some explanatory text to some of the
headings, so they don't consist only of steps.
- In 'Miscellaneous Information', added a little bit more description to
the various info screens.
- I thought the section on debugging GLib criticals in 'Debugging Tips'
would work better as a set of steps.
- In 'Watch Expressions', added some explanation about what a watch is.
- Edited spelling, grammar, style, etc.
manuals/anjuta-manual/C/autotools-build-build.page | 20 ++++----
.../anjuta-manual/C/debug-breakpoint-dialog.page | 30 ++++++-----
manuals/anjuta-manual/C/debug-breakpoint.page | 49 +++++++++++------
manuals/anjuta-manual/C/debug-cpu.page | 12 ++--
manuals/anjuta-manual/C/debug-custom.page | 4 +-
manuals/anjuta-manual/C/debug-expression.page | 10 +++-
manuals/anjuta-manual/C/debug-information.page | 31 ++++++-----
manuals/anjuta-manual/C/debug-local.page | 10 ++--
manuals/anjuta-manual/C/debug-process-dialog.page | 8 ++--
manuals/anjuta-manual/C/debug-run.page | 33 ++++++------
manuals/anjuta-manual/C/debug-stack.page | 27 +++++-----
manuals/anjuta-manual/C/debug-step.page | 39 +++++++-------
manuals/anjuta-manual/C/debug-thread.page | 15 +++--
manuals/anjuta-manual/C/debug-tips.page | 55 +++++++++++++++----
manuals/anjuta-manual/C/debug-watch.page | 45 +++++++++++-----
manuals/anjuta-manual/C/run-run.page | 2 +-
16 files changed, 234 insertions(+), 156 deletions(-)
---
diff --git a/manuals/anjuta-manual/C/autotools-build-build.page b/manuals/anjuta-manual/C/autotools-build-build.page
index fa24a6a..bc263e2 100644
--- a/manuals/anjuta-manual/C/autotools-build-build.page
+++ b/manuals/anjuta-manual/C/autotools-build-build.page
@@ -19,15 +19,15 @@
<title>Build targets</title>
<p>
- A target is a file created from source files, typically it is a program
- or a library, but it could be a documentation if some processing is
- needed.
+ A target is a file created from source files. Typically, it is a program
+ or a library, but it could also be documentation if the documentation needs
+ processing, for example.
</p>
<p>
- The build command compile all needed sources files and link them
- with possibly some other files, like libraries, in order to create the target.
+ The build command compiles all needed source files, and possibly links them
+ with some other files, like libraries, in order to create the target.
If some source files are already compiled and haven't been modified,
- they are not be recompiled to gain time. There are several ways
+ they are not be recompiled, in order to save time. There are several ways
to trigger a build.
</p>
<steps>
@@ -35,7 +35,7 @@
<p>
From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
<gui>Build</gui></guiseq> or press <key>F7</key> to build all
- target in the same directory than the current edited file.
+ targets in the same directory as the currently opened file.
</p>
</item>
</steps>
@@ -44,7 +44,7 @@
<p>
From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
<gui>Build Project</gui></guiseq> or press <keyseq><key>Shift</key><key>F7</key></keyseq>
- to build the complete project, all subdirectories are built recursively.
+ to build the complete project. All subdirectories are built recursively.
</p>
</item>
</steps>
@@ -57,7 +57,7 @@
<item>
<p>
Click on the right mouse button to make the <gui>file manager context menu</gui>
- appears and select <guiseq><gui>Build</gui><gui>Build</gui></guiseq>
+ appear and select <guiseq><gui>Build</gui><gui>Build</gui></guiseq>
to build all targets in the directory currently selected or the parent directory of the
currently selected file.
</p>
@@ -72,7 +72,7 @@
<item>
<p>
Click on the right mouse button to make the <gui>project manager context menu</gui>
- appears and select <guiseq><gui>Build</gui><gui>Build</gui></guiseq>
+ appear and select <guiseq><gui>Build</gui><gui>Build</gui></guiseq>
to build all targets in the directory containing the currently selected file or target.
</p>
</item>
diff --git a/manuals/anjuta-manual/C/debug-breakpoint-dialog.page b/manuals/anjuta-manual/C/debug-breakpoint-dialog.page
old mode 100755
new mode 100644
index 5cfe0ca..de17949
--- a/manuals/anjuta-manual/C/debug-breakpoint-dialog.page
+++ b/manuals/anjuta-manual/C/debug-breakpoint-dialog.page
@@ -21,31 +21,35 @@
<terms>
<item>
<title><gui>Location</gui></title>
- <p>This is the position of the breakpoint. This cannot be changed on a
- existing breakpoint. It can be specified using the following
+ <p>This is the position of the breakpoint. For an existing breakpoint, you
+ cannot change this. You can set a breakpoint at a certain line number, or
+ at the beginning of a function. Use one of the following
formats:</p>
<list>
- <item><p><var>file_name:line_number</var></p></item>
+ <item><p><var>file_name</var>:<var>line_number</var></p></item>
<item><p><var>function_name</var></p></item>
- <item><p><var>file_name:function_name</var></p></item>
+ <item><p><var>file_name</var>:<var>function_name</var></p></item>
</list>
</item>
<item>
<title><gui>Condition</gui></title>
- <p>It is an expression which should evaluate to a boolean value TRUE(1) or
- FALSE(0).
+ <p>The break condition is an expression which should evaluate to a boolean
+ value <code>TRUE</code> (1) or <code>FALSE</code> (0).
Every time the breakpoint is encountered during your program's execution,
the break condition will be evaluated. The debugger will break the execution
- only if the evaluation result is the TRUE value.</p>
- <p>If you leave this field blank the condition is considered as always
- TRUE.</p>
+ only if the result of the evaluation is <code>TRUE</code>.</p>
+ <p>If you leave this field blank the condition is always considered
+ <code>TRUE</code>.</p>
</item>
<item>
<title><gui>Pass Count</gui></title>
- <p>This is an integer (unsigned) value which tells the debugger to
- skip the breakpoint that number of times before it is considered. It
- has a higher priority than the condition. Only when the count reaches
- zero will the debugger evaluate the condition if it is present.</p>
+ <p>The debugger can also skip the breakpoint a certain number of times
+ before breaking. If the pass count is not zero, then the debugger will
+ have to encounter the breakpoint this number of times before breaking.</p>
+ <p>The pass count
+ has a higher priority than the condition. Only when the pass count has been
+ reached will the debugger evaluate the condition if it is present and break
+ the program's execution.</p>
</item>
</terms>
diff --git a/manuals/anjuta-manual/C/debug-breakpoint.page b/manuals/anjuta-manual/C/debug-breakpoint.page
old mode 100755
new mode 100644
index e2ef2b8..d8b1f3c
--- a/manuals/anjuta-manual/C/debug-breakpoint.page
+++ b/manuals/anjuta-manual/C/debug-breakpoint.page
@@ -17,8 +17,8 @@
<title>Breakpoints</title>
- <p>Breakpoints are used to stop the execution of the program at particular
- points so that the state of the program can be examined at those locations.</p>
+ <p>Breakpoints are used to stop the execution of the program at a particular
+ point so that the state of the program can be examined at those locations.</p>
<section>
<title>Listing breakpoints</title>
@@ -27,7 +27,7 @@
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>View</gui>
<gui>Breakpoints</gui></guiseq> to open the <gui>Breakpoint</gui>
- windows.</p>
+ window.</p>
</item>
</steps>
@@ -47,7 +47,7 @@
</item>
<item>
<title>Type</title>
- <p>This always displays "breakpoint". It will be used in a
+ <p>This always displays <gui>breakpoint</gui>. It will be used in a
future release supporting different kinds of breakpoints.</p>
</item>
<item>
@@ -69,7 +69,7 @@
<p>This is the state of the breakpoint. It may be</p>
<terms>
<item><title>Pending:</title><p>the breakpoint is not set in your program.</p></item>
- <item><title>Permanent:</title><p>the breakpoint is set (its id number is given inside parenthesis).</p></item>
+ <item><title>Permanent:</title><p>the breakpoint is set (its id number is displayed in parentheses).</p></item>
<item><title>Temporary:</title><p>the breakpoint is set but will be deleted if reached.</p></item>
</terms>
</item>
@@ -77,7 +77,7 @@
<note style="tip">
<p>All breakpoints are kept across Anjuta sessions even if they correspond
- to a non-existing locations by example in a source file of a shared library not
+ to a non-existing locations, for example in a source file of a shared library not
loaded yet. In this case their states are set as pending.</p>
</note>
</section>
@@ -93,15 +93,16 @@
</p>
</item>
<item>
- <p>Fill at least the <gui>Location</gui> which is the position of the
- breakpoint, if a file is currently opened in the editor it is
- fill to put a breakpoint in the current line by default.
+ <p>Fill in the <gui>Location</gui>, which is the position of the
+ breakpoint, and the other fields if desired.
+ If a file is currently opened in the editor, the <gui>Location</gui>
+ defaults to the current line.
See <link xref="debug-breakpoint-dialog"/> for more information.</p>
</item>
</steps>
<p>Another solution is to use the toggle breakpoint function. If there
- is no breakpoint on the current line, it will add one. Else it will
+ is no breakpoint on the current line, it will add one. Otherwise, it will
remove it.</p>
<steps>
@@ -119,6 +120,10 @@
<section>
<title>Editing breakpoints</title>
+ <p>You can't change the location of a breakpoint; create a new breakpoint
+ instead. However, you can change the break condition or the pass count. To
+ edit a breakpoint:</p>
+
<steps>
<item>
<p>Select a breakpoint in the <gui>Breakpoint</gui> window.</p>
@@ -129,8 +134,8 @@
</p>
</item>
<item>
- <p>Change the <gui>Condition</gui> and <gui>Pass Count</gui>
- field and click on <gui>OK</gui> to commit the changes.
+ <p>Change the <gui>Condition</gui> or <gui>Pass Count</gui>
+ fields and click on <gui>OK</gui> when you are done.
See <link xref="debug-breakpoint-dialog"/> for more information.</p>
</item>
</steps>
@@ -141,6 +146,11 @@
<section>
<title>Removing breakpoints</title>
+ <p>You can remove a breakpoint using the toggle breakpoint function
+ described above. However, if you want to remove more than one breakpoint
+ or the breakpoint is in a different file than the one you are editing,
+ you can use the breakpoint window:</p>
+
<steps>
<item>
<p>Select a breakpoint in the <gui>Breakpoint</gui> window.</p>
@@ -152,14 +162,14 @@
</item>
</steps>
- <p>You can remove all breakpoints using:</p>
+ <p>To remove all breakpoints:</p>
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Remove All Breakpoints</gui></guiseq> or right click in
+ <gui>Remove All Breakpoints</gui></guiseq> or right-click in
the <gui>Breakpoint</gui> window and select
- <gui>Remove All Breakpoint</gui>.</p>
+ <gui>Remove All Breakpoints</gui>.</p>
</item>
</steps>
@@ -169,9 +179,12 @@
<section>
<title>Enabling and disabling breakpoints</title>
+ <p>Sometimes you might want to disable a breakpoint temporarily instead of
+ deleting it altogether. To disable or re-enable a breakpoint:</p>
+
<steps>
<item>
- <p>Click on the <gui>Enable</gui> column in the <gui>Breakpoint</gui>
+ <p>Click on the <gui>Enable</gui> checkmark in the <gui>Breakpoint</gui>
window or right click in the <gui>Breakpoint</gui> window and
select <gui>Enable Breakpoint</gui> or <gui>Disable Breakpoint</gui>.</p>
</item>
@@ -182,9 +195,9 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Disable All Breakpoints</gui></guiseq> or right click in
+ <gui>Disable All Breakpoints</gui></guiseq> or right-click in
the <gui>Breakpoint</gui> window and select
- <gui>Disable All Breakpoint</gui>.</p>
+ <gui>Disable All Breakpoints</gui>.</p>
</item>
</steps>
diff --git a/manuals/anjuta-manual/C/debug-cpu.page b/manuals/anjuta-manual/C/debug-cpu.page
old mode 100755
new mode 100644
index f21070b..681f916
--- a/manuals/anjuta-manual/C/debug-cpu.page
+++ b/manuals/anjuta-manual/C/debug-cpu.page
@@ -7,7 +7,7 @@
<link type="guide" xref="debug-data" group="sixth"/>
<revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
<desc>
- Examine CPU informations.
+ Examine CPU information.
</desc>
<credit type="author">
<name>SÃbastien Granjoux</name>
@@ -28,7 +28,7 @@
</item>
</steps>
- <p>Register which value has changed since the last stop are in red. It is
+ <p>Registers whose values have changed since the last stop are in red. It is
possible to change the value of any register by clicking in the value
column and entering a new value.</p>
@@ -50,7 +50,7 @@
memory contents in ASCII.</p>
<p>The addressing space of even a 32-bit microprocessor is very large
(4 gigabytes), so it is very difficult to go to a particular address
- with the scrollbar. But you can click on the right mouse button and select
+ with the scrollbar. But you can click the right mouse button and select
<gui>Go to address</gui> to get a small edit box where you can enter an
address in hexadecimal.</p>
</section>
@@ -63,7 +63,7 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>View</gui>
- <gui>Memory</gui></guiseq> to open the <gui>Memory</gui>
+ <gui>Disassembly</gui></guiseq> to open the <gui>Disassembly</gui>
window.</p>
</item>
</steps>
@@ -77,8 +77,8 @@
<p>The addressing space of even a 32-bit microprocessor is very large
(4 gigabytes), so it is very difficult to go to a particular address
- with the scrollbar. But you can click on the right mouse button and select
- <gui>Goto address</gui> to get a small edit box where you can enter an
+ with the scrollbar. But you can click the right mouse button and select
+ <gui>Go to address</gui> to get a small edit box where you can enter an
address in hexadecimal.</p>
</section>
diff --git a/manuals/anjuta-manual/C/debug-custom.page b/manuals/anjuta-manual/C/debug-custom.page
index d18f4fe..60a1ed5 100755
--- a/manuals/anjuta-manual/C/debug-custom.page
+++ b/manuals/anjuta-manual/C/debug-custom.page
@@ -17,7 +17,7 @@
<title>Custom command</title>
- <p>Custom command can be send to the debugger using:</p>
+ <p>You can send a custom command to the debugger like this:</p>
<steps>
<item>
@@ -34,7 +34,7 @@
<note style="warning">
<p>The command is sent directly to the debugger without performing any checks.
- By example if you set a breakpoint like this, it will not appear in the
+ For example, if you set a breakpoint like this, it will not appear in the
<gui>Breakpoint</gui> window. It is better to avoid using this
command unless you know exactly what you are doing.</p>
</note>
diff --git a/manuals/anjuta-manual/C/debug-expression.page b/manuals/anjuta-manual/C/debug-expression.page
index 50f792e..2f7ddba 100755
--- a/manuals/anjuta-manual/C/debug-expression.page
+++ b/manuals/anjuta-manual/C/debug-expression.page
@@ -20,15 +20,19 @@
<section>
<title>Inspect an expression and modify a variable</title>
+ <p>While you are debugging a program, you can find out the value
+ of an expression or variable while the program is paused.
+ It is also sometimes useful to change the value of a variable.</p>
+
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Inspect/Evaluate</gui></guiseq> or right click in the
- <gui>Editor</gui> window and select <gui>Inspect/Evaluate</gui>.</p>
+ <gui>Inspect/Evaluate...</gui></guiseq> or right click in the
+ <gui>Editor</gui> window and select <gui>Inspect/Evaluate...</gui>.</p>
</item>
<item>
<p>If the expression is a variable name, you can change its value
- by clicking on the <gui>Value</gui> column and enter a new value.</p>
+ by clicking on the <gui>Value</gui> column and entering a new value.</p>
</item>
</steps>
diff --git a/manuals/anjuta-manual/C/debug-information.page b/manuals/anjuta-manual/C/debug-information.page
index 138781f..b5787fb 100755
--- a/manuals/anjuta-manual/C/debug-information.page
+++ b/manuals/anjuta-manual/C/debug-information.page
@@ -7,7 +7,7 @@
<link type="guide" xref="debug-data" group="seventh"/>
<revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
<desc>
- Examine additional program informations.
+ Examine additional program information.
</desc>
<credit type="author">
<name>SÃbastien Granjoux</name>
@@ -15,7 +15,10 @@
</credit>
</info>
- <title>Miscellaneous informations</title>
+ <title>Miscellaneous information</title>
+
+ <p>The debugger can tell you various information about the program while it is
+ running.</p>
<section>
<title>View shared libraries</title>
@@ -27,9 +30,9 @@
</item>
</steps>
- <p>This open a window which will list all shared libraries the program has loaded
+ <p>This opens a window which will list all shared libraries the program has loaded
and their locations in memory. It also shows whether each library's symbol table is
- loaded or not (Yes/No).</p>
+ loaded or not.</p>
</section>
@@ -39,11 +42,11 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Info</gui><gui>Kernels signals</gui></guiseq>.</p>
+ <gui>Info</gui><gui>Kernel signals</gui></guiseq>.</p>
</item>
</steps>
- <p>This list all available signals with a small description and three
+ <p>This lists all available signals with a small description and three
columns to specify what to do when a signal is received:</p>
<terms>
@@ -54,16 +57,16 @@
</item>
<item>
<title>Print</title>
- <p>The debugger display the received signal.</p>
+ <p>The debugger displays the received signal.</p>
</item>
<item>
<title>Pass</title>
- <p>The debugger pass the signal to the program.</p>
+ <p>The debugger passes the signal to the program.</p>
</item>
</terms>
<note style="bug">
- <p>The context menu that is displayed when you click on the right mouse
+ <p>The context menu that is displayed when you click the right mouse
button has all its items disabled because the corresponding functions
are not implemented yet.</p>
</note>
@@ -77,14 +80,14 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Info</gui><gui>Info Target files</gui></guiseq>.</p>
+ <gui>Info</gui><gui>Info Target Files</gui></guiseq>.</p>
</item>
</steps>
</section>
<section>
- <title>Information about program</title>
+ <title>Information about the program</title>
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
@@ -99,7 +102,7 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Info</gui><gui>Kernel user struct</gui></guiseq>.</p>
+ <gui>Info</gui><gui>Info Kernel User Struct</gui></guiseq>.</p>
</item>
</steps>
</section>
@@ -109,13 +112,13 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Info</gui><gui>Info Global Variable</gui></guiseq>.</p>
+ <gui>Info</gui><gui>Info Global Variables</gui></guiseq>.</p>
</item>
</steps>
</section>
<section>
- <title>Information about the current frame</title>
+ <title>Information about the current stack frame</title>
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
diff --git a/manuals/anjuta-manual/C/debug-local.page b/manuals/anjuta-manual/C/debug-local.page
index 7322b1a..4e58ca5 100755
--- a/manuals/anjuta-manual/C/debug-local.page
+++ b/manuals/anjuta-manual/C/debug-local.page
@@ -30,7 +30,7 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>View</gui>
- <gui>Locals</gui></guiseq> to open the <gui>Local</gui>
+ <gui>Locals</gui></guiseq> to open the <gui>Locals</gui>
window.</p>
</item>
</steps>
@@ -45,11 +45,11 @@
</item>
<item>
<title>Value</title>
- <p>The variable value</p>
+ <p>The variable value.</p>
</item>
<item>
<title>Type</title>
- <p>The type of the variable</p>
+ <p>The type of the variable.</p>
</item>
</terms>
</section>
@@ -59,11 +59,11 @@
<steps>
<item>
- <p>In the <gui>Local</gui> window, select the variable you want to
+ <p>In the <gui>Locals</gui> window, select the variable you want to
edit and double click in the <gui>Value</gui> column.</p>
</item>
<item>
- <p>Type the new value</p>
+ <p>Type the new value.</p>
</item>
</steps>
</section>
diff --git a/manuals/anjuta-manual/C/debug-process-dialog.page b/manuals/anjuta-manual/C/debug-process-dialog.page
index d705dcf..021df16 100755
--- a/manuals/anjuta-manual/C/debug-process-dialog.page
+++ b/manuals/anjuta-manual/C/debug-process-dialog.page
@@ -15,14 +15,14 @@
</credit>
</info>
- <title>Attach to process Dialog</title>
+ <title>Attach to Process Dialog</title>
- <p>The <gui>process</gui> dialog allows you to select a currently running process</p>
+ <p>The <gui>Attach to process</gui> dialog allows you to select a currently running process.</p>
<terms>
<item>
<title><gui>Hide paths</gui></title>
- <p>This hides command pathes in the process list if checked.</p>
+ <p>This hides command paths in the process list if checked.</p>
</item>
<item>
<title><gui>Hide process parameters</gui></title>
@@ -30,7 +30,7 @@
</item>
<item>
<title><gui>Display process tree</gui></title>
- <p>If unchecked, the processes are displayed in a list. If checked the
+ <p>If unchecked, the processes are displayed in a list. If checked, the
processes are displayed in a tree.</p>
</item>
</terms>
diff --git a/manuals/anjuta-manual/C/debug-run.page b/manuals/anjuta-manual/C/debug-run.page
index cdc985f..8b9193e 100755
--- a/manuals/anjuta-manual/C/debug-run.page
+++ b/manuals/anjuta-manual/C/debug-run.page
@@ -22,9 +22,9 @@
<section>
<title>Start a program in the debugger</title>
- <p>The current program is defined in the <gui>run parameter</gui> dialog.
+ <p>The current program is defined in the <gui>Program Parameters</gui> dialog.
See <link xref="run-parameters-dialog"/> for more information. This
- program can be started in the debugger using:</p>
+ program can be started in the debugger like this:</p>
<steps>
<item>
@@ -35,9 +35,10 @@
<note style="tip">
<p>A program can be more difficult to debug if it is highly optimized
- or if debugging information are missing. This is defined in the
- configure step. Normally, a Debug configuration with no optimization
- and all debugging informations is defined. Anjuta display a warning
+ or if debugging information is missing. Whether optimization and debugging
+ information are enabled, is defined in the configure step.
+ Normally, there is a Debug configuration available, that turns off optimization
+ and includes all debugging information. Anjuta displays a warning
if this configuration is not used.
See <link xref="autotools-build-configure"/> for more information.</p>
</note>
@@ -46,16 +47,16 @@
<section>
<title>Debug an already running application</title>
- <p>The debugger could be used on an already running application.</p>
+ <p>The debugger can be used on an already running application.</p>
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Run</gui>
<gui>Debug Process...</gui></guiseq>
- to get a dialog listing all currently running process.</p>
+ to get a dialog listing all currently running processes.</p>
</item>
<item>
- <p>Select a process in the <gui>attach to process</gui> dialog
+ <p>Select a process in the <gui>Attach to process</gui> dialog
and click on <gui>Attach</gui> to start the debugger on this
process. See <link xref="debug-process-dialog"/> for more details.</p>
</item>
@@ -66,7 +67,7 @@
<title>Debug a remote application</title>
<p>The debugger can be used to debug an application running on another
- computer connected through a TCP or a serial connection.</p>
+ computer connected through a TCP or serial connection.</p>
<steps>
<item>
@@ -74,14 +75,14 @@
<gui>Debug Remote...</gui></guiseq></p>
</item>
<item>
- <p>Select the type of the connection with the remote application,
- <gui>Serial Line</gui> or <gui>TCP/IP</gui>.</p>
+ <p>Select the type of the connection to the remote application,
+ <gui>Serial Line Connection</gui> or <gui>TCP/IP Connection</gui>.</p>
</item>
<item>
- <p>For a TCP connection, fill <gui>Address</gui> and <gui>Port</gui>
- field</p>
- <p>For a serial connection, fill the text box below with the serial
- device name, by example <cmd>/dev/ttyb</cmd>.</p>
+ <p>For a TCP connection, fill in the <gui>Address</gui> and <gui>Port</gui>
+ fields.</p>
+ <p>For a serial connection, fill in the text box below with the serial
+ device name, for example <cmd>/dev/ttyb</cmd>.</p>
</item>
<item>
<p>Click on <gui>Connect</gui> to start the debugger and connect to
@@ -94,7 +95,7 @@
<section>
<title>Stop the debugger</title>
- <p>The debugger and the program can be stop at any time using:</p>
+ <p>The debugger and the program can be stopped at any time like this:</p>
<steps>
<item>
diff --git a/manuals/anjuta-manual/C/debug-stack.page b/manuals/anjuta-manual/C/debug-stack.page
index 4510fe6..da3781f 100755
--- a/manuals/anjuta-manual/C/debug-stack.page
+++ b/manuals/anjuta-manual/C/debug-stack.page
@@ -7,7 +7,7 @@
<link type="guide" xref="debug-data" group="fourth"/>
<revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
<desc>
- Examine stack.
+ Examine the stack.
</desc>
<credit type="author">
<name>SÃbastien Granjoux</name>
@@ -22,7 +22,8 @@
<p>A stack frame is the area of the stack associated to each function call.
It lists all functions and their arguments in the sequence they were called.
- Each stack frame is numbered starting from 0 for the current function.</p>
+ Each stack frame is numbered starting from 0 for the current function.
+ You can only view the stack frames while the debugger is running.</p>
<steps>
<item>
@@ -37,15 +38,15 @@
<terms>
<item>
<title>Active</title>
- <p>This contains a yellow arrow to represent the active stack frame, by
- default it is the frame 0, the current function. All evaluations and
- local variables are relative to this selected frame. You can change
+ <p>This contains a yellow arrow to represent the active stack frame. By
+ default it is frame 0, the current function. All evaluations and
+ local variables are relative to this active frame. You can change
the active stack frame to examine local variables in other functions.</p>
</item>
<item>
<title>Frame</title>
- <p>This is the frame number stating from 0 for the current function.
- The first function of your program, main for a C program by example,
+ <p>This is the frame number starting from 0 for the current function.
+ The first function of your program, for example <code>main()</code> in a C program,
has the highest number.</p>
</item>
<item>
@@ -75,28 +76,28 @@
<section>
- <title>Change current stack frame</title>
+ <title>Change the current stack frame</title>
<steps>
<item>
<p>In the <gui>Stack</gui> window, select the frame you want.</p>
</item>
<item>
- <p>Right click and select <gui>Set current frame</gui></p>
+ <p>Right-click and select <gui>Set current frame</gui>.</p>
</item>
</steps>
</section>
<section>
- <title>View current function</title>
+ <title>View the current function</title>
<steps>
<item>
<p>In the <gui>Stack</gui> window, select the frame you want.</p>
</item>
<item>
- <p>Double click or right click and select <gui>View Source</gui></p>
+ <p>Double-click, or right-click and select <gui>View Source</gui>.</p>
</item>
</steps>
</section>
@@ -107,8 +108,8 @@
<steps>
<item>
- <p>In the <gui>Stack</gui> window right click and select
- <gui>Get stack trace</gui></p>
+ <p>In the <gui>Stack</gui> window, right-click and select
+ <gui>Get stack trace</gui>.</p>
</item>
</steps>
</section>
diff --git a/manuals/anjuta-manual/C/debug-step.page b/manuals/anjuta-manual/C/debug-step.page
index 7cad9b4..ee575da 100755
--- a/manuals/anjuta-manual/C/debug-step.page
+++ b/manuals/anjuta-manual/C/debug-step.page
@@ -18,8 +18,9 @@
<title>Stop and step</title>
<p>Like a video editing session, the program can be executed in slow motion
- with the ability to go forward, pause, stop, and so on. You cannot go
- backward yet though. This is essential for tracking program behavior.</p>
+ with the ability to go forward, pause, stop, and so on.
+ This is essential for tracking program behavior. You cannot go
+ backward yet, though.</p>
<section>
<title>Step in</title>
@@ -27,8 +28,8 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Step In</gui></guiseq> or press <key>F5</key></p> or
- click on the <gui>Step In</gui> icon in the toolbar.
+ <gui>Step In</gui></guiseq> or press <key>F5</key> or
+ click on the <gui>Step In</gui> icon in the toolbar.</p>
</item>
</steps>
@@ -57,13 +58,13 @@
</item>
</steps>
- <p>Stepping over is similar to step in except that it does not stop
+ <p>Stepping over is similar to stepping except that it does not stop
inside any function in the statement being executed.</p>
<note style="advanced">
<p>If the <gui>Disassembly window</gui> has the focus when
- this command is selected, it executes only one assembler instruction except
- if this instruction is a call to a subroutine, in this case the program stops
+ this command is selected, it executes only one assembler instruction, except
+ if that instruction is a call to a subroutine, in which case the program stops
when the subroutine is completed.</p>
</note>
</section>
@@ -75,12 +76,12 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Step Out</gui></guiseq> or press <keyseq><key>Shift</key><key>F5</key></keyseq></p> or
- click on the <gui>Step Out</gui> icon in the toolbar.
+ <gui>Step Out</gui></guiseq> or press <keyseq><key>Shift</key><key>F5</key></keyseq> or
+ click on the <gui>Step Out</gui> icon in the toolbar.</p>
</item>
</steps>
- <p>It executes the current function until it returns to the calling
+ <p>Stepping out executes the current function until it returns to the calling
function.</p>
</section>
@@ -91,12 +92,12 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Run/Continue</gui></guiseq> or press <key>F4</key></p> or
- click on the <gui>Continue</gui> icon in the toolbar.
+ <gui>Run/Continue</gui></guiseq> or press <key>F4</key> or
+ click on the <gui>Continue</gui> icon in the toolbar.</p>
</item>
</steps>
- <p>This command restarts the program until a breakpoint is encountered or
+ <p>This command restarts the program and lets it run until a breakpoint is encountered or
the program exits.</p>
</section>
@@ -106,18 +107,18 @@
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
- <gui>Run to Cursor</gui></guiseq> or press <key>F8</key></p> or
- click on the <gui>Run to</gui> icon in the toolbar.
+ <gui>Run to Cursor</gui></guiseq> or press <key>F8</key> or
+ click on the <gui>Run to</gui> icon in the toolbar.</p>
</item>
</steps>
- <p>This restarts the program until the line or the
+ <p>This restarts the program and lets it run until the line or the
address (if the <gui>Disassembly window</gui> has the focus) at
the cursor is reached.</p>
</section>
<section>
- <title>Stop Program</title>
+ <title>Stopping the Program</title>
<steps>
<item>
@@ -127,8 +128,8 @@
</item>
</steps>
- <p>This interrupts the program and return control to the debugger allowing
- perform all debugging tasks, like inspecting data, adding breakpoints...</p>
+ <p>This interrupts the program and returns control to the debugger, allowing
+ you to perform debugging tasks, like inspecting data or adding breakpoints.</p>
</section>
diff --git a/manuals/anjuta-manual/C/debug-thread.page b/manuals/anjuta-manual/C/debug-thread.page
index 9c430fa..2978c00 100755
--- a/manuals/anjuta-manual/C/debug-thread.page
+++ b/manuals/anjuta-manual/C/debug-thread.page
@@ -21,8 +21,8 @@
<title>List threads</title>
<p>A program can be composed of several threads. All these threads are
- executed independently having their own registers, stack and local
- variables but sharing global variables.</p>
+ executed independently, having their own registers, stack and local
+ variables, but sharing global variables.</p>
<steps>
<item>
@@ -32,12 +32,12 @@
</item>
</steps>
- <p>Each thread contains the following information:</p>
+ <p>The window shows the following information about each thread:</p>
<terms>
<item>
<title>Active</title>
- <p>This contains a yellow arrow to represent the active thread.</p>
+ <p>This contains a yellow arrow that points to the active thread.</p>
</item>
<item>
<title>ID</title>
@@ -70,12 +70,15 @@
<section>
<title>Change current thread</title>
+ <p>The current thread is the thread whose stack and local variables are
+ currently displayed in the debugger.</p>
+
<steps>
<item>
<p>In the <gui>Thread</gui> window, select the thread you want.</p>
</item>
<item>
- <p>Right click and select <gui>Set current thread</gui></p>
+ <p>Right-click and select <gui>Set current thread</gui>.</p>
</item>
</steps>
</section>
@@ -89,7 +92,7 @@
<p>In the <gui>Thread</gui> window, select the thread you want.</p>
</item>
<item>
- <p>Double click or right click and select <gui>View Source</gui></p>
+ <p>Double-click, or right-click and select <gui>View Source</gui>.</p>
</item>
</steps>
</section>
diff --git a/manuals/anjuta-manual/C/debug-tips.page b/manuals/anjuta-manual/C/debug-tips.page
index 1ed1ac8..e0c1af0 100755
--- a/manuals/anjuta-manual/C/debug-tips.page
+++ b/manuals/anjuta-manual/C/debug-tips.page
@@ -15,22 +15,53 @@
</credit>
</info>
- <title>Debug tips</title>
+ <title>Debugging tips</title>
<section>
- <title>Fix Glib/Gtk+ critical errors</title>
+ <title>Fixing GLib/GTK+ critical errors</title>
- <p>A program can be stopped as soon as it gets a GLib critical errors if
- the environment variable <sys>G_DEBUG</sys> has the value
- <sys>fatal_criticals</sys>. This environment variable can be set in the
- <link xref="run-parameters-dialog"/>.</p>
- <p>Then you need to run the program with the debugger and use it until
- you get the critical error. At that time, the debugger will stop your
- program and you have to look at the
- <link xref="debug-stack"/> to check where this error comes from.</p>
+ <p>Sometimes it can be difficult to track down where GLib critical errors are
+ occurring, since they do not stop the program.
+ You can set the program to stop as soon as it gets a GLib critical error, by setting
+ the environment variable <sys>G_DEBUG</sys> to the value
+ <sys>fatal_criticals</sys>.</p>
+
+ <steps>
+ <item>
+ <p>Open the <link xref="run-parameters-dialog"/> by selecting
+ <guiseq><gui>Run</gui><gui>Program Parameters...</gui></guiseq> from the
+ main menu.</p>
+ </item>
+ <item>
+ <p>Click the plus sign next to <gui>Environment Variables</gui> to expand
+ the list of environment variables.</p>
+ </item>
+ <item>
+ <p>Click <gui>New</gui> to add a new entry to the list.</p>
+ </item>
+ <item>
+ <p>Fill in <gui>Name</gui> with <input>G_DEBUG</input> and <gui>Value</gui>
+ with <input>fatal_criticals</input>.</p>
+ </item>
+ <item>
+ <p>Click <gui>Apply</gui> to confirm the changes.</p>
+ </item>
+ <item>
+ <p>Run the program with the debugger by selecting
+ <guiseq><gui>Run</gui><gui>Debug Program</gui></guiseq> from the main menu.</p>
+ </item>
+ <item>
+ <p>Use the program until the critical error occurs.</p>
+ </item>
+ <item>
+ <p>When the debugger stops your program, look at the
+ <link xref="debug-stack"/> to check where this error comes from.</p>
+ </item>
+ </steps>
+
<p>The top function with frame number 0 is in GLib, so you have to look
- down in the stack, typically the error comes from the first function in your
- program.</p>
+ down in the stack. Typically the error originates from the topmost
+ function that belongs to your program.</p>
</section>
diff --git a/manuals/anjuta-manual/C/debug-watch.page b/manuals/anjuta-manual/C/debug-watch.page
index 182a0ee..8a11001 100755
--- a/manuals/anjuta-manual/C/debug-watch.page
+++ b/manuals/anjuta-manual/C/debug-watch.page
@@ -15,7 +15,12 @@
</credit>
</info>
- <title>Watch expression</title>
+ <title>Watch expressions</title>
+
+ <p>Watch expressions, or watches for short, are expressions that the debugger
+ evaluates and prints the result of every time the program is stopped; for
+ example, after every <link xref="debug-step">single-step</link>
+ through the program.</p>
<section>
<title>List watched expressions</title>
@@ -28,7 +33,7 @@
</item>
</steps>
- <p>Like local variables, all watches expression are displayed in a tree view with children used to
+ <p>Like local variables, all watch expressions are displayed in a tree with children used to
represent structure or array members.</p>
<terms>
@@ -53,14 +58,18 @@
<p>Watch expressions can be updated automatically as soon as the
program is stopped or on user request.</p>
+ <p>To set a watch expression to update automatically:</p>
+
<steps>
<item>
- <p>In the <gui>Watches</gui> windows select the watch you want to
- update automatically, right click and check that <gui>Automatic Update</gui>
- if checked, if not select it.</p>
+ <p>In the <gui>Watches</gui> window, select the watch you want to
+ update automatically. Right-click and check that <gui>Automatic Update</gui>
+ if checked. If not, select it.</p>
</item>
</steps>
+ <p>To update a watch expression manually:</p>
+
<steps>
<item>
<p>In the <gui>Watches</gui> window, right click and select <gui>Update Watch</gui> to
@@ -68,6 +77,8 @@
</item>
</steps>
+ <p>To update all watch expressions manually at once:</p>
+
<steps>
<item>
<p>In the <gui>Watches</gui> window, right click and select <gui>Update all</gui> to
@@ -81,20 +92,22 @@
<section>
<title>Add a watch on an expression</title>
+ <p>To add an expression to the watch list:</p>
+
<steps>
<item>
<p>From the <gui>main menu</gui>, select <guiseq><gui>Debug</gui>
<gui>Add Watch...</gui></guiseq> or in the <gui>Watches</gui>
- windows right click and select <gui>Add Watch...</gui>.</p>
+ window, right-click and select <gui>Add Watch...</gui>.</p>
</item>
<item>
<p>Enter the expression to watch. Check <gui>Automatic Update</gui>
- if you want that the expression is evaluated each time the program
+ if you want the expression to be evaluated each time the program
is stopped.</p>
</item>
</steps>
- <p>An expression can be evaluate and then added as a watch using:</p>
+ <p>An expression can be evaluated and then added as a watch like this:</p>
<steps>
<item>
@@ -103,7 +116,7 @@
<gui>Editor</gui> window and select <gui>Inspect/Evaluate</gui>.</p>
</item>
<item>
- <p>Click on <gui>Add</gui> button to add this expression in the watches
+ <p>Click on <gui>Add</gui> button to add this expression to the watches
list.</p>
</item>
</steps>
@@ -113,10 +126,12 @@
<section>
<title>Remove a watch</title>
+ <p>You can remove an expression from the watches list.</p>
+
<steps>
<item>
- <p>In the <gui>Watches</gui> windows select the watch you want to remove
- then right click and select <gui>Remove Watch</gui>.</p>
+ <p>In the <gui>Watches</gui> window, select the watch you want to remove,
+ then right-click and select <gui>Remove Watch</gui>.</p>
</item>
</steps>
@@ -124,7 +139,7 @@
<steps>
<item>
- <p>In the <gui>Watches</gui> right click and select <gui>Remove all</gui>.</p>
+ <p>In the <gui>Watches</gui> window, right-click and select <gui>Remove all</gui>.</p>
</item>
</steps>
@@ -133,10 +148,12 @@
<section>
<title>Changing the value of a variable</title>
+ <p>If a watch expression corresponds to a variable, you can change
+ its value.</p>
+
<steps>
<item>
- <p>If a watch expression corresponds to a variable you can change
- its value. In the <gui>Watches</gui> window, select the variable you want to
+ <p>In the <gui>Watches</gui> window, select the variable you want to
edit and double click in the <gui>Value</gui> column.</p>
</item>
<item>
diff --git a/manuals/anjuta-manual/C/run-run.page b/manuals/anjuta-manual/C/run-run.page
index a2a864a..7c1a61c 100644
--- a/manuals/anjuta-manual/C/run-run.page
+++ b/manuals/anjuta-manual/C/run-run.page
@@ -20,7 +20,7 @@
<title>Run a program</title>
<p>If <app>Anjuta</app> is used to start a program it checks that it is
- up to date and build it if needed.</p>
+ up to date and builds it if needed.</p>
<steps>
<item>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
