You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by kw...@apache.org on 2022/08/15 06:46:48 UTC

[sling-maven-plugin] branch master updated: releng: some more cleanup, javadoc fixes

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-maven-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new a88b711  releng: some more cleanup, javadoc fixes
a88b711 is described below

commit a88b71191162c54f3e35804fab6fe4408f90f44b
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Aug 15 08:46:43 2022 +0200

    releng: some more cleanup, javadoc fixes
---
 pom.xml                                                              | 3 +--
 .../apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java  | 1 +
 src/main/java/org/apache/sling/maven/bundlesupport/FsMountMojo.java  | 5 ++---
 src/site/markdown/bundle-installation.md                             | 3 ++-
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/pom.xml b/pom.xml
index 2d7d6ba..f3177be 100644
--- a/pom.xml
+++ b/pom.xml
@@ -284,7 +284,7 @@
             <version>${mavenVersion}</version>
             <scope>provided</scope>
         </dependency>
-        <!-- use for evaluating Adapter annotations -->
+        <!-- used for evaluating Adapter annotations -->
         <dependency>
             <groupId>io.github.classgraph</groupId>
             <artifactId>classgraph</artifactId>
@@ -332,7 +332,6 @@
                         </plugin>
                     </plugins>
                 </pluginManagement>
-                
             </build>
         </profile>
         <!-- This plugin's configuration is used to store Eclipse m2e settings only. It has no influence on the Maven build itself. -->
diff --git a/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java b/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java
index 0fb788b..9354fc3 100644
--- a/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java
+++ b/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java
@@ -56,6 +56,7 @@ abstract class AbstractBundleInstallMojo extends AbstractBundleRequestMojo {
      *  <a href="https://sling.apache.org/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling Post Servlet</a> for deployment (HTTP POST).
      *  Make sure that {@link #slingUrl} points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).</li>
      * </ol>
+     * For more details refer to <a href="bundle-installation.html">Bundle Installation</a>.
      * 
      * This has precedence over the deprecated parameter {@link #usePut}.
      * If nothing is set the default is either {@code WebConsole} or {@code WebDAV} (when {@link #usePut} is {@code true}).
diff --git a/src/main/java/org/apache/sling/maven/bundlesupport/FsMountMojo.java b/src/main/java/org/apache/sling/maven/bundlesupport/FsMountMojo.java
index 2753387..3a35516 100644
--- a/src/main/java/org/apache/sling/maven/bundlesupport/FsMountMojo.java
+++ b/src/main/java/org/apache/sling/maven/bundlesupport/FsMountMojo.java
@@ -80,13 +80,12 @@ public class FsMountMojo extends AbstractFsMountMojo {
      *  Make sure that {@link #slingUrl} points to the Felix Web Console in that case.</li>
      *  <li><strong>WebDAV</strong>, uses <a href="https://sling.apache.org/documentation/development/repository-based-development.html">
      *  WebDAV</a> for deployment (HTTP PUT). Make sure that {@link #slingUrl} points to the entry path of 
-     *  the Sling WebDAV bundle (usually below regular Sling root URL). Issues a HTTP Delete for the uninstall goal.
+     *  the Sling WebDAV bundle (defaults to {@code /dav/default} in the Sling starter). Issues a HTTP Delete for the uninstall goal.</li>
      *  <li><strong>SlingPostServlet</strong>, uses the
      *  <a href="https://sling.apache.org/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling Post Servlet</a> for deployment (HTTP POST).
      *  Make sure that {@link #slingUrl} points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).</li>
      * </ol>
-     * 
-     * This has precedence over the deprecated parameter {@link #usePut}.
+     * For more details refer to <a href="bundle-installation.html">Bundle Installation</a>.
      * @since 2.3.0
      */
     @Parameter(property="sling.deploy.method", required = false, defaultValue = "WebConsole")
diff --git a/src/site/markdown/bundle-installation.md b/src/site/markdown/bundle-installation.md
index d354877..3d4d072 100644
--- a/src/site/markdown/bundle-installation.md
+++ b/src/site/markdown/bundle-installation.md
@@ -23,7 +23,8 @@ Since version 2.1.8 you can also leverage the [Sling POST servlet](https://sling
 
 ### Felix Web Console
 
-The plugin by default places an *HTTP POST* request to the [Felix Web Console](https://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests). This will achieve both uninstallation of the bundle in one request *synchronously*.
+Places an *HTTP POST* request to the [Felix Web Console](https://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests). This will achieve 
+uninstallation of the bundle *synchronously*.
 
 ### WebDAV PUT