[jackrabbit-filevault-package-maven-plugin] branch master updated: javadoc: clarify relation of goal generate-metadata and package

[kw...@apache.org]

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/jackrabbit-filevault-package-maven-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 301b547  javadoc: clarify relation of goal generate-metadata and package
301b547 is described below

commit 301b54780591ad8ba6788b26ac55fcede6f4c3de
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Thu Oct 28 07:33:46 2021 +0200

    javadoc: clarify relation of goal generate-metadata and package
---
 .../jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java    | 4 +++-
 .../org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java    | 2 +-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java
index 64353e0..80fcb50 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java
@@ -92,10 +92,12 @@ import aQute.bnd.header.Parameters;
 import aQute.bnd.osgi.Processor;
 
 /**
- * Generates the metadata ending up in the package like {@code META-INF/MANIFEST.MF} as well as the
+ * Generates the metadata ending up in the content package like {@code META-INF/MANIFEST.MF} as well as the
  * files ending up in {@code META-INF/vault} like {@code filter.xml}, {@code properties.xml}, {@code config.xml} and
  * {@code settings.xml}. Those files will be written to the directory given via parameter {@link #workDirectory}.
  * In addition performs some validations.
+ * Also configures artifacts (like OSGi bundles or subpackages) to be embedded in the content package as those may affect metadata as well.
+ * The generated metadata is usually packaged in a content package in a subsequent goal {@code package}.
  * @since 1.0.3
  */
 @Mojo(
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
index a12944c..7bf5c90 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
@@ -67,7 +67,7 @@ import org.apache.maven.shared.utils.io.MatchPatterns;
 import org.apache.maven.shared.utils.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
-/** Builds a content package. */
+/** Builds a content package. Uses the metadata generated by and embedded artifacts (like subpackages or OSGi bundles) configured in an execution of goal {@code generate-metadata}. */
 @Mojo(name = "package", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
 public class VaultMojo extends AbstractSourceAndMetadataPackageMojo {