Bug 516956 - Add documentation for launch groups
Change-Id: I62b1e7ca3169a2b3d2b494c6805ad8e5b9d2af10
Signed-off-by: Markus Duft <markus.duft@ssi-schaefer.com>
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm b/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm
new file mode 100644
index 0000000..f1a31aa
--- /dev/null
+++ b/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm
@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
+<HEAD>
+
+<meta name="copyright" content="Copyright (c) SSI Schaefer IT Solutions GmbH and others 2017. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
+
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
+<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
+
+<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
+<TITLE>Launch groups</TITLE>
+
+<link rel="stylesheet" type="text/css" HREF="../book.css">
+</HEAD>
+<BODY BGCOLOR="#ffffff">
+<h3>Launch groups</h3>
+<p>The <b>Launch Group</b> launch configuration type allows you to launch multiple other launch configurations
+ sequentially, with configurable actions after launching each group member:
+ <ul>
+ <li>None: Continue launching the next member right away</li>
+ <li>Wait until terminated: Continue launching the next member only after this member has terminated</li>
+ <li>Delay: Delay launching the next member for a given amount of seconds.</li>
+ <li>Wait for console output (regexp): Allows to delay further
+ processing of launch group elements until a certain output (matching a regular expression)
+ appears on the console of the given group element</li>
+ </ul>
+ <p>
+ <img src="images/improved-launch-groups.png" alt="Launch Groups"/>
+ </p>
+ <p> New launch groups can be created via the <b>Run > Run Configurations...</b> or <b>Run > Debug Configurations...</b> dialogs.</p>
+<p>
+The <b>Adopt launch if already running</b> option allows to control behaviour of the group when
+the launch configuration referenced by the launch group element is already running
+(no matter who launched it). If checked, the launch configuration will not be launched
+again if it is running already. The existing launch will be adopted by the group (i.e.
+terminating the group will also terminate this launch). Any configured post launch
+action will still be executed!
+</p>
+</BODY>
+</HTML>
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/images/improved-launch-groups.png b/bundles/org.eclipse.platform.doc.isv/guide/images/improved-launch-groups.png
new file mode 100644
index 0000000..e0a0f0d
--- /dev/null
+++ b/bundles/org.eclipse.platform.doc.isv/guide/images/improved-launch-groups.png
Binary files differ
diff --git a/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml b/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml
index 7c9b8c6..99b4d60 100644
--- a/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml
+++ b/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml
@@ -305,6 +305,8 @@
<topic label="Launch configuration dialog" href="guide/debug_launch_ui.htm" />
<topic label="Launch configuration type images" href="guide/debug_launch_uiimages.htm" />
<topic label="Launch shortcuts" href="guide/debug_launch_uishortcuts.htm" />
+ <topic href="guide/debug_launch_groups.htm" label="Launch groups">
+ </topic>
</topic>
<topic label="Debugging a program" href="guide/debug_debug.htm" >
<topic label="Platform debug model" href="guide/debug_model.htm" />
