svn commit: r1740244 - /sling/site/trunk/content/documentation/development/slingstart.mdtext

[kw...@apache.org]

Author: kwin
Date: Thu Apr 21 07:11:17 2016
New Revision: 1740244

URL: http://svn.apache.org/viewvc?rev=1740244&view=rev
Log:
SLING-4677 add documentation around starting/stopping servers with slingstart-maven-plugin and debug options

Modified:
    sling/site/trunk/content/documentation/development/slingstart.mdtext

Modified: sling/site/trunk/content/documentation/development/slingstart.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/slingstart.mdtext?rev=1740244&r1=1740243&r2=1740244&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/slingstart.mdtext (original)
+++ sling/site/trunk/content/documentation/development/slingstart.mdtext Thu Apr 21 07:11:17 2016
@@ -1,5 +1,7 @@
 Title: The Apache Sling Provisioning Model and Apache SlingStart
 
+[TOC]
+
 The Apache Sling provisioning model is a model to describe OSGi based application. It can also be used to define a partial application aka feature (or subsystem in OSGi terms).
 
 The model is describing an instance, it is not directly related to any particular tooling or packaging/provisioning vehicle.
@@ -192,7 +194,7 @@ Notice that this definition only support
 
 ## Slingstart and Slingfeature projects
 
-The slingstart Maven plugin introduces two new packaging types:
+The slingstart-maven-plugin introduces two new packaging types:
 
 * slingstart : This type requires a model at src/main/provisioning. It reads all text files in that directory and merges them in alphabetical order. The resulting artifact is a runnable jar. The assembled model is also attached to the project artifacts.
 * slingfeature : This type requires a model at src/main/provisioning. It reads all text files in that directory and merges them in alphabetical order and creates a merged model which is the final artifact of this project.
@@ -277,13 +279,28 @@ When the merge directive is used, the co
 
 If a merged configuration redefines a property that already exists, it overwrites it, so the last configuration supplied in a merge wins.
 
+## slingstart-maven-plugin
+
+### Starting a server
+
+Use the goal with name `start` to start one or multiple servers. The goal is bound by default to the [`pre-integration-test` lifecycle phase](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#Lifecycle_Reference).
+
+#### Debugging
+
+Since version 1.2.0 of this plugin it is possible to easily start a Sling server in debug mode ([SLING-4677](https://issues.apache.org/jira/browse/SLING-4677)). For that you either configure the property `debug` inside you server configuration in the pom.xml accordingly or by using the parameter `Dlaunchpad.debug`. Both values can either be `true` (in which case the [JDWT options](http://docs.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html#Invocation) `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000` are appended to the VM options) or just some arbitrary string defining JDWT options.
+In case both are used the parameter `Dlaunchpad.debug` takes precedence.
+
+### Stopping a server 
+
+Use the goal with name `stop` to stop one or multiple servers. The goal is bound by default to the [`post-integration-test` lifecycle phase](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#Lifecycle_Reference).
+
 ## Known Issues
 
 ### Support of configuration formats
 
 The provisioning model supports two formats to define configurations, properties and the format of the Apache Felix ConfigAdmin implementation.
 
-Starting with version 1.2.0 of the provisioning model and version 1.2.0 of the slingstart maven plugin, the implementation uses the latest format from Apache Felix, version 1.8.6 (or higher) of the ConfigAdmin. This requires you to use version 3.6.6 (or higher) of the OSGi installer core bundle to handle these configurations.
+Starting with version 1.2.0 of the provisioning model and version 1.2.0 of the slingstart-maven-plugin, the implementation uses the latest format from Apache Felix, version 1.8.6 (or higher) of the ConfigAdmin. This requires you to use version 3.6.6 (or higher) of the OSGi installer core bundle to handle these configurations.
 
 If you want to stick with the old format from config admin, you can configure the maven plugin as follows: