Author: rombert
Date: Fri Dec 13 16:57:03 2013
New Revision: 1550770
URL: http://svn.apache.org/r1550770
Log:
Fix table layout in 'Maven Sling Plugin' page
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=1550770&r1=1550769&r2=1550770&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/sling.mdtext (original)
+++ sling/site/trunk/content/documentation/development/sling.mdtext Fri Dec 13
16:57:03 2013
@@ -80,6 +80,7 @@ To use the `deploy` goal of the Maven Sl
### Configuration
The `deploy` goal may be configured in the `<configuration>` element using the
following properties:
+
| Parameter | Default Value | System Property Overwrite | Description |
|--|--|--|--|
| `skip` | `false` | `sling.deploy.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 deployment of the bundle to a Sling OSGi Bundle
Repository server if it is known that there is none or if such an upload is not
required. |
@@ -103,10 +104,12 @@ Specifying the bundle file to upload wit
### Configuration
The `deploy-file` supports similar configuration parameters as the `deploy`
goal with the exception of the `skip` parameter which makes no sense. In
addition, all parameters must be specified on the command line by setting
system properties. The `bundleFileName` parameter specified as the `sling.file`
system property as well as the `obr` URL are required by the `deploy-file` goal.
+
| Parameter | Default Value | System Property Overwrite | Description |
|--|--|--|--|
| `bundleFileName` |
`$\{project.build.directory}/$\{project.build.finalName}.jar` | `sling.file` |
The path and name of the file to be installed |
| `obr` | \- | `obr` | The URL of the running Sling instance to which the
bundle is installed. Note that this parameter is required and has no defualt
value. It must always be specified in the configuration section or on the
command line. |
+
Example: To deploy the bundle file `someBundle.jar` to the OBR running at
`[http://obr.sample.org](http://obr.sample.org)` you might use the goal as
follows:
$ mvn org.apache.sling:maven-sling-plugin:deploy-file
-Dsling.file=someBundle.jar -Dobr=http://obr.sample.org
@@ -150,6 +153,7 @@ To use the `install` goal of the Maven S
### Configuration
The `install` goal may be configured in the `<configuration>` element using
the following properties:
+
| 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. |
@@ -159,10 +163,9 @@ The `install` goal may be configured in
| `slingUrl` | `http{`}`://localhost:8080/sling` | `sling.url` | The URL of
the running Sling instance to which the bundle is installed |
| `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 |
-
-
| `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. |
| `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\[\]({{ refs..path }}))` method
is called after installing or updating the bundle. |
+
{anchor:install-file}
## The `install-file` goal
@@ -227,6 +230,7 @@ To use the `uninstall` goal of the Maven
### Configuration
The `uninstall` goal may be configured in the `<configuration>` element using
the following properties:
+
| Parameter | Default Value | System Property Overwrite | Description |
|--|--|--|--|
| `bundleFileName` |
`$\{project.build.directory}/$\{project.build.finalName}.jar` | `sling.file` |
The path and name of the file to be uninstalled |
@@ -234,6 +238,7 @@ The `uninstall` goal may be configured i
| `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 |
| `usePut` | `false` | `sling.usePut` | In the uninstall goal, a HTTP DELETE
will be used. |
+
{anchor:validate}
## The `validate` goal
@@ -274,6 +279,7 @@ To use the `validate` goal of the Maven
### Configuration
The `validate` goal may be configured in the `<configuration>` element using
the following properties:
+
| Parameter | Default Value | System Property Overwrite | Description |
|--|--|--|--|
| `skip` | `false` | `sling.validation.skip` | Whether to skip the validation |
