[nemiver/mallard-docs: 14/28] Clean debug-*page
- From: Baptiste Mille-Mathias <baptistem src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nemiver/mallard-docs: 14/28] Clean debug-*page
- Date: Mon, 15 Jul 2013 18:45:51 +0000 (UTC)
commit a69a7cb63d41354be510c785e65f900464720b1a
Author: Baptiste Mille-Mathias <baptistem gnome org>
Date: Sat Jun 8 01:53:27 2013 +0200
Clean debug-*page
Rename for consistency and add a paragraph for each page
help/C/debug-core-file.page | 4 +++
help/C/debug-program.page | 44 +++++++++++++++++++++++++++++++++++++
help/C/debug-remote-target.page | 5 ++-
help/C/debug-running-program.page | 5 ++++
4 files changed, 56 insertions(+), 2 deletions(-)
---
diff --git a/help/C/debug-core-file.page b/help/C/debug-core-file.page
index 1d9ab39..98d93da 100644
--- a/help/C/debug-core-file.page
+++ b/help/C/debug-core-file.page
@@ -4,10 +4,14 @@
<info>
<link type="guide" xref="index#overview"/>
+ <desc>To debug program already crashed</desc>
</info>
<title>Debug a program using a core file</title>
+ <p>This method is to use when a program has already crashed and you need to
+ understand afterwards what happened.</p>
+
<p>To debug a core file, choose <guiseq><gui>File</gui>, <gui>Load Core
File…</gui></guiseq>, then a new window appears:</p> <list>
<item><p><gui>Core File</gui>, choose the core file you want to
diff --git a/help/C/debug-program.page b/help/C/debug-program.page
new file mode 100644
index 0000000..522c1b3
--- /dev/null
+++ b/help/C/debug-program.page
@@ -0,0 +1,44 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ type="topic"
+ id="launch-a-program-to-debug">
+
+ <info>
+ <link type="guide" xref="index#overview"/>
+ <desc>The usual way to debug a program</desc>
+ </info>
+
+ <title>Launch a program to debug</title>
+
+ <p>You want to use this method, when you need to debug a program not started
+ yet. This is usually the method you want to use when debugging a small
+ program.</p>
+
+ <section id="interface">
+ <title>From <app>Nemiver</app> interface</title>
+
+ <p>Choose <guiseq><gui>File</gui><gui>Load Executable…</gui></guiseq>, a new window
+ opens:</p>
+ <list>
+ <item><p><gui>Program</gui> choose the program installed on your
+ machine to launch.</p></item> <item><p><gui>Arguments</gui>, you can
+ enter optional arguments you want to pass to the program to
+ debug.</p></item> <item><p><gui>Working Directory</gui>, the place
+ from where the program will start.</p></item>
+ <item><p><gui>Environment Variables</gui>, optionnal variables that
+ may affect the program to debug to.</p></item>
+ </list>
+ <p>Once set, choose <gui>Execute</gui> to start the debugging session.</p>
+ </section>
+
+ <section id="command-line">
+ <title>From command-line</title>
+ <p>It is possible to launch a debugging session from a terminal,
+ <cmd>nemiver</cmd><var>program</var> where <var>program</var> can be
+ the name of the binary of a program or a full path to a program.</p>
+
+ <p>Should you need to pass arguments to the program to debug,
+ note you have to enclose the program and the arguments between
+ quotes, <cmd>nemiver</cmd>"<var>program --arg1 --arg2</var>".
+ </p>
+ </section>
+</page>
diff --git a/help/C/debug-remote-target.page b/help/C/debug-remote-target.page
index cb4ed36..a58d0d6 100644
--- a/help/C/debug-remote-target.page
+++ b/help/C/debug-remote-target.page
@@ -4,12 +4,13 @@
<info>
<link type="guide" xref="index#overview"/>
+ <desc>When you want to remote a program running remotely or on a device</desc>
</info>
<title>Debug a remote target</title>
- <p><app>Nemiver</app> can be used program that run either on a remote
- machine running gdbserver or a device plugged to your local machine.</p>
+ <p><app>Nemiver</app> can be used to debug program that run either on a
+ remote machine running gdbserver or a device plugged to your local machine.</p>
<p>To debug such program, choose <guiseq><gui>File</gui>, <gui>Connect to
Remote Target…</gui></guiseq>, then a new window appears:</p>
diff --git a/help/C/debug-running-program.page b/help/C/debug-running-program.page
index 4db4e6a..1f14e9e 100644
--- a/help/C/debug-running-program.page
+++ b/help/C/debug-running-program.page
@@ -4,10 +4,15 @@
<info>
<link type="guide" xref="index#overview"/>
+ <desc>When you want to debug a currently running program</desc>
</info>
<title>Debug a running program</title>
+ <p>This method is to use when you need to debug a program you can't stop,
+ because you're not sure you will be able to reproduce the conditions that
+ cause the bug for instance.</p>
+
<section id="interface">
<title>From <app>Nemiver</app> interface</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]