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

[kw...@apache.org]

Author: kwin
Date: Wed Mar  2 12:49:20 2016
New Revision: 1733274

URL: http://svn.apache.org/viewvc?rev=1733274&view=rev
Log:
add hints, which options are applying to which deployment method, add description of "mimeType"

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

Modified: sling/site/trunk/content/documentation/development/sling.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/sling.mdtext?rev=1733274&r1=1733273&r2=1733274&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/sling.mdtext (original)
+++ sling/site/trunk/content/documentation/development/sling.mdtext Wed Mar  2 12:49:20 2016
@@ -158,16 +158,17 @@ The `install` goal may be configured in
 | Parameter | Default Value | System Property Overwrite | Description |
 |--|--|--|--|
 | `skip` | `false` | `sling.install.skip` | Whether to skip this step even though it has been configured in the project to be executed. The main use of this setting is preventing installation of the bundle to a running Sling installation if it is known that there is none or if such an upload is not required, for example when building the bundle in an automated build system such as Confluence. |
-| `bundleFileName` | `${project.build.directory}/${project.build.finalName}.jar` | `sling.file` | The path and name of the file to be installed |
-| `bundleStart` | `true` | `sling.bundle.start` | Whether to start the bundle after installing it. If the bundle is just updated, this parameter is ignored even if the bundle is currently stopped |
-| `bundleStartLevel` | `20` | `sling.bundle.startlevel` | The start level to set on the installed bundle. If the bundle is already installed and therefore is only updated this parameter is ignored. The parameter is also ignored if the running Sling instance has no StartLevel service (which is unusual actually) |
+| `bundleFileName` | `${project.build.directory}/${project.build.finalName}.jar` | `sling.file` | The path and name of the file to be installed. Only applies when POSTing to Felix Web Console. |
+| `bundleStart` | `true` | `sling.bundle.start` | Whether to start the bundle after installing it. If the bundle is just updated, this parameter is ignored even if the bundle is currently stopped. Only applies when POSTing to Felix Web Console. |
+| `bundleStartLevel` | `20` | `sling.bundle.startlevel` | The start level to set on the installed bundle. If the bundle is already installed and therefore is only updated this parameter is ignored. The parameter is also ignored if the running Sling instance has no StartLevel service (which is unusual actually). Only applies when POSTing to Felix Web Console. |
 | `slingUrl` | `http://localhost:8080/sling` | `sling.url` | The URL of the running Sling instance to which the bundle is installed |
 | `slingUrlSuffix` |  | `sling.urlSuffix` | An optional url suffix which will be appended to the `sling.url` for use as the real target url. This allows to configure different target URLs in each POM, while using the same common `sling.url` in a parent POM. This is typically only used in conjunction with `WebDAV` or `SlingPostServlet` deployment methods. |
 | `user` | `admin` | `sling.user` | The name of the user to authenticate as with the running Sling instance given by the `slingUrl` parameter |
 | `password` | `admin` | `sling.password` | The password of the user to authenticate as with the running Sling instance given by the `slingUrl` parameter |
 | `deploymentMethod` | `WebConsole` | `sling.deploy.method` | Only available since version 2.1.8 (see also [SLING-5335](https://issues.apache.org/jira/browse/SLING-5335)). <br>Allowed values:<br>**WebConsole**, uses the [Felix Web Console REST API](http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests) for deployment (HTTP POST). This is the default. Make sure that `slingUrl` points to the Felix Web Console in that case.<br>**WebDAV**, uses [WebDAV]({{ refs.repository-based-development.path }}) for deployment (HTTP PUT). Make sure that `slingUrl` points to the entry path of the Sling WebDAV bundle (usually below regular Sling root URL). Issues an HTTP Delete for the uninstall goal.<br>**SlingPostServlet**, uses the [Sling Post Servlet]({{ refs.manipulating-content-the-slingpostservlet-servlets-post.path }}) for deployment (HTTP POST). Make sure that `slingUrl` points a path which is handled by the Sling POST Servlet (us
 ually below regular Sling root URL). |
+| `mimeType` | `application/java-archive` | `sling.mimeType` | The content type / mime type used for WebDAV or Sling POST deployment. |
 | `usePut` | `false` | `sling.usePut` | If a simple HTTP PUT should be used instead of the standard POST to the  felix console. In the uninstall goal, a HTTP DELETE will be  used. Deprecated since version 2.1.8 (see also [SLING-5335](https://issues.apache.org/jira/browse/SLING-5335)). Use `deploymentMethod=WebDAV` instead. |
-| `refreshPackages` | `true` | `sling.refreshPackages` | Whether to refresh the packages after installing the uploaded bundle. If this property is set to `true`, the `PackageAdmin.refreshPackages(Bundle)` method is called after installing or updating the bundle. |
+| `refreshPackages` | `true` | `sling.refreshPackages` | Whether to refresh the packages after installing the uploaded bundle. If this property is set to `true`, the `PackageAdmin.refreshPackages(Bundle)` method is called after installing or updating the bundle. Only applies when POSTing to Felix Web Console |
 
 #### Intermediate Node Creation
 For all `deploymentMethod`s except WebDAV the bundle is not directly deployed within the OSGi container, but rather being uploaded to the JCR and from there on being picked up by the [JCR Installer Provider]({{ refs.jcr-installer-provider.path }}) asynchronously, which takes care of deploying it in the OSGi container.
@@ -247,6 +248,8 @@ The `uninstall` goal may be configured i
 | `deploymentMethod` | `WebConsole` | `sling.deploy.method` | Only available since version 2.1.8 (see also [SLING-5335](https://issues.apache.org/jira/browse/SLING-5335)). <br>Allowed values:<br>**WebConsole**, uses the [Felix Web Console REST API](http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests) for deployment (HTTP POST). This is the default. Make sure that `slingUrl` points to the Felix Web Console in that case.<br>**WebDAV**, uses [WebDAV]({{ refs.repository-based-development.path }}) for deployment (HTTP PUT). Make sure that `slingUrl` points to the entry path of the Sling WebDAV bundle (usually below regular Sling root URL). Issues an HTTP Delete for the uninstall goal.<br>**SlingPostServlet**, uses the [Sling Post Servlet]({{ refs.manipulating-content-the-slingpostservlet-servlets-post.path }}) for deployment (HTTP POST). Make sure that `slingUrl` points a path which is handled by the Sling POST Servlet (us
 ually below regular Sling root URL). |
 | `usePut` | `false` | `sling.usePut` | If a simple HTTP PUT should be used instead of the standard POST to the  felix console. In the uninstall goal, an HTTP DELETE will be used. Deprecated since version 2.1.8 (see also [SLING-5335](https://issues.apache.org/jira/browse/SLING-5335)). Use `deploymentMethod=WebDAV` instead. |
 
+
+
 ## The `validate` goal
 
 The `validate` goal checks the JSON code of a bundle.