GNOME.org
 

[nemiver/mallard-docs: 1/28] Starting mallard documentation

commit 56b5038190d9a5a8041a6790d5b4ac19f24112a0
Author: Baptiste Mille-Mathias <baptiste millemathias gmail com>
Date:   Sun Apr 28 21:53:17 2013 +0200

    Starting mallard documentation
    
    Deleted all the previous documentation and started from a white sheet.

 help/C/contact.page                        |   19 +
 help/C/debug-core-file.page                |   26 +
 help/C/debug-remote-target.page            |   27 +
 help/C/debug-running-program.page          |   24 +
 help/C/figures/attach-dialog.png           |  Bin 82583 -> 0 bytes
 help/C/figures/connect-remote-dialog.png   |  Bin 29157 -> 0 bytes
 help/C/figures/disabled-breakpoint.png     |  Bin 6064 -> 0 bytes
 help/C/figures/enabled-breakpoint.png      |  Bin 6216 -> 0 bytes
 help/C/figures/execute-dialog.png          |  Bin 33326 -> 0 bytes
 help/C/figures/global-variables-dialog.png |  Bin 10533 -> 0 bytes
 help/C/figures/load-core-dialog.png        |  Bin 18149 -> 0 bytes
 help/C/figures/main-interface.png          |  Bin 0 -> 17162 bytes
 help/C/figures/main-window.png             |  Bin 27862 -> 0 bytes
 help/C/figures/memory-view.png             |  Bin 51520 -> 0 bytes
 help/C/figures/nemiver.png                 |  Bin 0 -> 828 bytes
 help/C/figures/open-files-filesystem.png   |  Bin 77407 -> 0 bytes
 help/C/figures/open-files-target.png       |  Bin 34193 -> 0 bytes
 help/C/figures/preferences-dialog.png      |  Bin 42826 -> 0 bytes
 help/C/figures/registers-view.png          |  Bin 26965 -> 0 bytes
 help/C/figures/sessions-dialog.png         |  Bin 25411 -> 0 bytes
 help/C/figures/set-breakpoint-dialog.png   |  Bin 25967 -> 0 bytes
 help/C/figures/variable-inspector.png      |  Bin 25548 -> 0 bytes
 help/C/index.docbook                       |  907 ----------------------------
 help/C/index.page                          |   23 +
 help/C/interface.page                      |   14 +
 help/C/launch-a-program-to-debug.page      |   36 ++
 help/C/report-bug.page                     |   20 +
 help/C/what-is-nemiver.page                |   16 +
 28 files changed, 205 insertions(+), 907 deletions(-)
---
diff --git a/help/C/contact.page b/help/C/contact.page
new file mode 100644
index 0000000..989dc48
--- /dev/null
+++ b/help/C/contact.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic"
+       id="support">
+
+       <info>
+       <link type="guide" xref="index#support"/>
+       </info>
+
+       <title>Contact</title>
+
+       <p>In any case you have question or need support, you can contact users and developers of 
<app>Nemiver</app> on the following channels:</p>
+       <list>
+               <item><p>email: <app>Nemiver</app> has a <link href="mailto:nemiver-list gnome 
org">mailing-list</link>, where you can ask question.
+               You might want to check the mailing-list <link 
href="http://mail.gnome.org/archives/nemiver-list";>archives</link> before sending a mail.</p></item>
+               <item><p>IRC: Channel <link href="irc://irc.gimp.org/#c++">C++</link> on server
+               <sys>irc.gimpnet.org</sys>. While this channel is not dedicated to <app>Nemiver</app>,
+               the developers are often connected there.</p></item>
+       </list>
+</page>
diff --git a/help/C/debug-core-file.page b/help/C/debug-core-file.page
new file mode 100644
index 0000000..607203e
--- /dev/null
+++ b/help/C/debug-core-file.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="debug-core-file">
+
+      <info>
+               <link type="guide" xref="index#overview"/>
+      </info>
+
+    <title>Debug a program using a core file</title>
+
+       <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 debug.</p></item>
+               <item><p><gui>Executable</gui>, choose the executable file that generate the 
+               core file. It should be the same exact version.</p></item>
+       </list>
+
+       <section id="what-is-core-file">
+               <title>What is a core file</title>
+               
+               <p>A core file is a file that contains a detail description of a program when
+               it crashed. It's useful to do a post-mortem analysis after a crash in order 
+               to reproduce it and correct the underlaying problem that introduced the 
+               crash.</p>
+       </section>
+</page>
diff --git a/help/C/debug-remote-target.page b/help/C/debug-remote-target.page
new file mode 100644
index 0000000..ffb3448
--- /dev/null
+++ b/help/C/debug-remote-target.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="debug-remote-target">
+
+      <info>
+       <link type="guide" xref="index#overview"/>
+      </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>To debug such program, choose <guiseq><gui>File</gui>, <gui>Connect to Remote 
Target…</gui></guiseq>, then a new window appears:</p>
+               <list>
+                       <item><p><gui>Executable to Load</gui></p></item>
+                       <item><p><gui>Shared Libraries Location</gui></p></item>
+                       <item><p><gui>Remote Debugging Server</gui></p>
+                       <list>
+                               <item><p>TCP/IP Connection</p></item>
+                               <item><p>Serial Line Connection</p></item>
+                       </list>
+                       </item>
+               </list>
+       
+       <p>choose <gui>OK</gui> to start the debugging session.</p>
+
+</page>
diff --git a/help/C/debug-running-program.page b/help/C/debug-running-program.page
new file mode 100644
index 0000000..fa06998
--- /dev/null
+++ b/help/C/debug-running-program.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="debug-running-program">
+
+      <info>
+               <link type="guide" xref="index#overview"/>
+      </info>
+
+    <title>Debug a running program</title>
+
+       <section id="interface">
+               <title>From <app>Nemiver</app> interface</title>
+
+               <p>To debug a program which is currently running, choose <guiseq><gui>File</gui>, <gui>Attach 
to Running Program…</gui></guiseq>, then select the program you want to debug in the list, and choose 
<gui>OK</gui>. You can narrow the list of programs by entering part of the target program you look for.</p>
+       </section>
+
+       <section id="command-line">
+               <title>From command-line</title>
+               <p>From a terminal, you can start directly a debugging session, type 
+               <cmd>nemiver --attach</cmd><var>program_name</var> where <var>program_name</var> is the 
program you want to debug. <var>program_name</var> can also be the Process ID of the program.</p>
+       </section>
+
+       <info>Add a note about search path</info>
+</page>
diff --git a/help/C/figures/main-interface.png b/help/C/figures/main-interface.png
new file mode 100644
index 0000000..cf145b6
Binary files /dev/null and b/help/C/figures/main-interface.png differ
diff --git a/help/C/figures/nemiver.png b/help/C/figures/nemiver.png
new file mode 100644
index 0000000..0a6a31c
Binary files /dev/null and b/help/C/figures/nemiver.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..fc18577
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,23 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+
+    <title><media type="image" src="figures/nemiver.png"></media>Nemiver</title>
+
+    <info>
+       <desc>The GNOME debugger</desc>
+    </info>
+
+    <section id="introduction" style="2column">
+        <title>Introduction</title>
+    </section>
+
+    <section id="overview" style="2column">
+        <title>Using Nemiver</title>
+    </section>
+
+    <section id="support" style="2column">
+        <title>Getting Support</title>
+    </section>
+
+</page>
diff --git a/help/C/interface.page b/help/C/interface.page
new file mode 100644
index 0000000..a806cc3
--- /dev/null
+++ b/help/C/interface.page
@@ -0,0 +1,14 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="interface">
+  <info>
+    <link type="guide" xref="index#introduction"/>
+    <revision version="0.1" date="2013-04-28" status="stub"/>
+    <desc></desc>
+  </info>
+
+  <title>Interface</title>
+
+  <p><media type="image" mime="image/png" src="figures/main-interface.png">The Main Interface</media></p>
+
+</page>
diff --git a/help/C/launch-a-program-to-debug.page b/help/C/launch-a-program-to-debug.page
new file mode 100644
index 0000000..7c4e553
--- /dev/null
+++ b/help/C/launch-a-program-to-debug.page
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic"
+       id="launch-a-program-to-debug">
+       
+       <info>
+               <link type="guide" xref="index#overview"/>
+       </info>
+
+       <title>Launch a program to debug</title>
+
+       <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/report-bug.page b/help/C/report-bug.page
new file mode 100644
index 0000000..7834852
--- /dev/null
+++ b/help/C/report-bug.page
@@ -0,0 +1,20 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic"
+       id="bugs">
+
+       <info>
+               <link type="guide" xref="index#support"/>
+       </info>
+
+       <title>Report a bug</title>
+
+       <p>Should you detect a problem, you should report it to in <link
+       href="https://bugzilla.gnome.org/enter_bug.cgi?product=nemiver";>bug tracker
+       application</link>. Alongside the details about to trigger the bug you 
+       encountered, you'll need to provide some information such as:</p>
+       <list>
+               <item><p>the distribution you are running on.</p></item>
+               <item><p>the version of Nemiver.</p></item>
+               <item><p>the version of GDB</p></item>
+       </list>
+</page>
diff --git a/help/C/what-is-nemiver.page b/help/C/what-is-nemiver.page
new file mode 100644
index 0000000..792d5a0
--- /dev/null
+++ b/help/C/what-is-nemiver.page
@@ -0,0 +1,16 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic"
+       id="what-is-nemiver">
+       
+       <info>
+               <link type="guide" xref="index#introduction"/>
+       </info>
+       
+       <title>What is Nemiver</title>
+       <p><app>Nemiver</app> is a graphical debugger built on top of GNOME 
+       technologies, an application that help to analyze bugs and weird behaviors
+       in a program.</p>
+       <p>Nemiver uses underneath <link href="http://www.gnu.org/software/gdb/";>GDB</link>
+       (the GNU debugger), as debugging engine, so as consequence Nemiver can 
+       debug C and C++ programs.</p>
+</page>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]