Doc: Debugger options in Build & Run options

Describe the new options dialog for adding debuggers.

Change-Id: Ic4f4041bb38f3e75aaa964543aaaaa7c0f7f7924
Reviewed-by: hjk <hjk121@nokiamail.com>

8 files changed, 103 insertions, 45 deletions

diff --git a/doc/src/debugger/creator-debugger-setup.qdoc b/doc/src/debugger/creator-debugger-setup.qdoc
index 9b462b1530..1e710ae65c 100644
--- a/doc/src/debugger/creator-debugger-setup.qdoc
+++ b/doc/src/debugger/creator-debugger-setup.qdoc
@@ -48,6 +48,10 @@
     you can \gui{Clone} the kit and change the parameters in
     the clone. Make sure to select the cloned kit for your project.
 
+    If the debugger you want to use is not automatically detected, select
+    \gui Tools > \gui Options > \gui {Build & Run} > \gui Debuggers > \gui Add
+    to add it.
+
     \note To use the debugging tools for Windows, you must install them
     and add the Symbol Server provided by Microsoft to the symbol search
     path of the debugger. For more information, see \l{Setting the Symbol
diff --git a/doc/src/debugger/creator-debugger.qdoc b/doc/src/debugger/creator-debugger.qdoc
index a111c988aa..1670720ea0 100644
--- a/doc/src/debugger/creator-debugger.qdoc
+++ b/doc/src/debugger/creator-debugger.qdoc
@@ -32,15 +32,17 @@
 
     \QC provides a debugger plugin that acts as an interface between the \QC
     core and external native debuggers such as the GNU Symbolic Debugger (GDB),
-    the Microsoft Console Debugger (CDB), and a QML/JavaScript debugger.
+    the Microsoft Console Debugger (CDB), a QML/JavaScript debugger, and the
+    debugger of the low level virtual machine (LLVM) project, LLDB.
 
     \list
 
         \li \l{Setting Up Debugger}
 
             The debugger plugin automatically selects a suitable
-            native debugger for your projects from the ones found
-            on your system. Manual overriding of this choice is possible.
+            native debugger for each \l{glossary-buildandrun-kit}{kit} from the
+            ones found on your system. You can edit the kits to override this
+            choice.
 
         \li \l{Launching the Debugger}
 
diff --git a/doc/src/projects/creator-projects-compilers.qdoc b/doc/src/projects/creator-projects-compilers.qdoc
index 7ab2957bc2..074ed3e5f4 100644
--- a/doc/src/projects/creator-projects-compilers.qdoc
+++ b/doc/src/projects/creator-projects-compilers.qdoc
@@ -26,7 +26,7 @@
     \contentspage index.html
     \previouspage creator-project-qmake.html
     \page creator-tool-chains.html
-    \nextpage creator-build-settings.html
+    \nextpage creator-debuggers.html
 
     \title Adding Compilers
 
diff --git a/doc/src/projects/creator-projects-debuggers.qdoc b/doc/src/projects/creator-projects-debuggers.qdoc
new file mode 100644
index 0000000000..b6b5632498
--- /dev/null
+++ b/doc/src/projects/creator-projects-debuggers.qdoc
@@ -0,0 +1,85 @@
+/****************************************************************************
+**
+** Copyright (c) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator
+**
+**
+** GNU Free Documentation License
+**
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
+**
+**
+****************************************************************************/
+
+// **********************************************************************
+// NOTE: the sections are not ordered by their logical order to avoid
+// reshuffling the file each time the index order changes (i.e., often).
+// Run the fixnavi.pl script to adjust the links to the index order.
+// **********************************************************************
+
+/*!
+    \contentspage index.html
+    \previouspage creator-tool-chains.html
+    \page creator-debuggers.html
+    \nextpage creator-build-settings.html
+
+    \title Adding Debuggers
+
+    The \QC debugger plugin acts as an interface between the \QC core and
+    external native debuggers such as the GNU Symbolic Debugger (GDB),
+    the Microsoft Console Debugger (CDB), a QML/JavaScript debugger, and the
+    debugger of the low level virtual machine (LLVM) project, LLDB.
+
+    The debugger plugin automatically selects a suitable native debugger for
+    each \l{glossary-buildandrun-kit}{kit} from the ones found on your system.
+    To override this choice, select \gui Tools > \gui Options >
+    \gui {Build & Run} > \gui Kits.
+
+    To add debuggers:
+
+    \list 1
+
+        \li Select \gui Tools > \gui Options > \gui {Build & Run} >
+            \gui Debuggers > \gui Add.
+
+        \li In the \gui Name field, give a descriptive name for the debugger.
+
+        \li In the \gui Path field, specify the path to the debugger binary:
+
+            \list
+
+                \li For CDB (Windows only), specify the path to the Windows
+                    Console Debugger executable.
+
+                \li For GDB, specify the path to the GDB executable. The
+                    executable must be built with Python scripting support
+                    enabled (except when debugging on Mac OS). The options you
+                    have depend on the development and target platform:
+
+                \list
+
+                    \li For debugging on embedded devices using a different ABI,
+                        you must provide a special executable.
+
+                    \li For debugging on Windows using MinGW, select a Windows
+                        executable of GDB with Python scripting enabled. You can
+                        download it from
+                        \l{http://builds.qt-project.org/job/gdb-windows}.
+
+                \endlist
+
+                \li For LLDB (experimental), specify the path to the LLDB
+                executable.
+
+            \endlist
+
+        \li In the \gui ABIs field, specify the ABI versions to use on embedded
+            devices.
+
+    \endlist
+*/
diff --git a/doc/src/projects/creator-projects-settings-build.qdoc b/doc/src/projects/creator-projects-settings-build.qdoc
index b16e8f76e6..81184b9cc8 100644
--- a/doc/src/projects/creator-projects-settings-build.qdoc
+++ b/doc/src/projects/creator-projects-settings-build.qdoc
@@ -24,7 +24,7 @@
 
 /*!
     \contentspage index.html
-    \previouspage creator-tool-chains.html
+    \previouspage creator-debuggers.html
     \page creator-build-settings.html
     \nextpage creator-run-settings.html
 
diff --git a/doc/src/projects/creator-projects-settings-overview.qdoc b/doc/src/projects/creator-projects-settings-overview.qdoc
index c4af7d7073..868c1b7216 100644
--- a/doc/src/projects/creator-projects-settings-overview.qdoc
+++ b/doc/src/projects/creator-projects-settings-overview.qdoc
@@ -52,7 +52,7 @@
 
     Each kit consists of a set of values that define one environment, such as a
     device, compiler, and Qt version. For more information, see
-    \l{Adding Qt Versions} and \l{Adding Compilers}.
+    \l{Adding Qt Versions}, \l{Adding Compilers}, and \l{Adding Debuggers}.
 
     To copy the build and run settings for a kit to another kit, select
     \gui {Copy to Kit} in the kit menu.
diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc
index 2e3e4b0988..3a41e48d3e 100644
--- a/doc/src/projects/creator-projects-targets.qdoc
+++ b/doc/src/projects/creator-projects-targets.qdoc
@@ -85,9 +85,11 @@
             if they are installed on the development PC, but were not detected
             automatically. For more information, see \l{Adding Compilers}.
 
-        \li In the \gui Debugger field, select \gui Auto-detect to automatically
-            detect a suitable debugger or \gui Edit to edit the currently selected
-            debugger. For more information, see \l{Selecting the Debugger}.
+        \li In the \gui Debugger field, select the debugger to debug the project
+            on the target platform. \QC automatically detects available
+            debuggers and displays a suitable debugger in the field. You can
+            add debuggers to the list. For more information, see
+            \l{Adding Debuggers}.
 
         \li In the \gui {Qt version} field, select the Qt version to use for
             building the project. You can add Qt versions to the list if they
@@ -104,40 +106,4 @@
 
     \endlist
 
-    \section1 Selecting the Debugger
-
-    To automatically detect a suitable debugger in the \gui Debugger field,
-    select \gui {Auto-detect}. This should work for the CDB engine
-    and for the GDB engine for local debugging on Linux or Mac OS.
-
-    To edit the selected debugger, select \gui Edit. In the
-    \gui {Debugger for} dialog, specify the type of debugger to use
-    (\gui {GDB Engine}, \gui {CDB Engine}, or \gui {LLDB Engine}) and the path
-    to the debugger binary:
-
-    \list
-
-    \li For the \gui {CDB Engine} (Windows only), specify the path to the Windows
-    Console Debugger executable.
-
-   \li For the \gui {GDB Engine}, specify the path to the GDB executable. The
-    executable must be built with Python scripting support enabled
-    (except when debugging on Mac OS). The options you have depend on the
-    development and target platform:
-
-    \list
-
-        \li For debugging on embedded devices using a different ABI, you must
-            provide a special executable.
-
-        \li For debugging on Windows using MinGW, select a Windows executable of
-            GDB with Python scripting enabled. You can download it from
-            \l{http://builds.qt-project.org/job/gdb-windows}.
-
-    \endlist
-
-    \li For the \gui {LLDB Engine} (experimental), specify the path to the LLDB
-    executable.
-
-    \endlist
 */
diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc
index 5430efb6f0..3221078da9 100644
--- a/doc/src/qtcreator.qdoc
+++ b/doc/src/qtcreator.qdoc
@@ -148,6 +148,7 @@
                 \li \l{Adding Kits}
                 \li \l{Adding Qt Versions}
                 \li \l{Adding Compilers}
+                \li \l{Adding Debuggers}
                 \li \l{Specifying Build Settings}
                 \li \l{Specifying Run Settings}
                 \li \l{Specifying Editor Settings}