You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2022/06/27 13:25:20 UTC
[jackrabbit-filevault-package-maven-plugin] branch master updated: JCRVLT-618 clarify documentation of repositoryStructurePackages parameter
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 a356dd9 JCRVLT-618 clarify documentation of repositoryStructurePackages parameter
a356dd9 is described below
commit a356dd9c8b4ce702e75fb043a263fa30fe84ba3d
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Jun 27 15:25:14 2022 +0200
JCRVLT-618 clarify documentation of repositoryStructurePackages
parameter
fix some javadoc glitches
---
.../maven/packaging/mojo/AbstractValidateMojo.java | 22 ++++++++++++++--------
.../maven/packaging/mojo/GenerateCndMojo.java | 2 +-
.../maven/packaging/mojo/ValidateFilesMojo.java | 2 +-
3 files changed, 16 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/AbstractValidateMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/AbstractValidateMojo.java
index efa0b07..9126681 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/AbstractValidateMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/AbstractValidateMojo.java
@@ -68,6 +68,9 @@ import org.sonatype.plexus.build.incremental.BuildContext;
public abstract class AbstractValidateMojo extends AbstractMojo {
public static final String IGNORE_GAV = "ignore";
+ /**
+ * Skips validation.
+ */
@Parameter(property = "vault.skipValidation", defaultValue = "false", required = true)
boolean skipValidation;
@@ -141,7 +144,7 @@ public abstract class AbstractValidateMojo extends AbstractMojo {
@Parameter(property = "vault.failOnValidationWarning", defaultValue = "false")
protected boolean failOnValidationWarnings;
- /** Defines the list of dependencies A dependency is declared as a {@code <dependency>} element of a list style {@code <dependencies>}
+ /** Defines the list of dependencies. A dependency is declared as a {@code <dependency>} element of a list style {@code <dependencies>}
* element:
*
* <pre>
@@ -167,14 +170,17 @@ public abstract class AbstractValidateMojo extends AbstractMojo {
@Parameter(property = "vault.dependencies")
protected Collection<MavenBasedPackageDependency> dependencies = new LinkedList<>();
- /** Defines the packages that define the repository structure. For the format description look at {@link #dependencies}.
+ /** Defines the packages that define the repository structure. They are sharing the same format as the elements used in {@link #dependencies}.
* <p>
- * The repository-init feature of sling-start can define initial content that will be available in the repository before the first
- * package is installed. Packages that depend on those nodes have no way to reference any dependency package that provides these nodes.
- * A "real" package that would creates those nodes cannot be installed in the repository, because it would void the repository init
- * structure. On the other hand would filevault complain, if the package was listed as dependency but not installed in the repository.
- * So therefore this repository-structure packages serve as indicator packages that helps satisfy the structural dependencies, but are
- * not added as real dependencies to the package. */
+ * The <a href="https://sling.apache.org/documentation/bundles/repository-initialization.html">repoinit feature</a> of Sling can define initial content that will be available in the repository before the first
+ * package is installed. Packages that depend on those nodes have no way to reference a regular dependency package that provides these nodes.
+ * A "real" package that would creates those nodes cannot be installed in the repository, because it would void the repoinit
+ * structure. On the other hand FileVault would complain, if the package was listed as dependency but not installed in the repository.
+ * Therefore these repository-structure packages serve as build-time only dependency that help satisfy the structural dependencies, but are
+ * not added as real (i.e. run-time) dependencies to the package.
+ * Repository-structure packages are only evaluated for their contained <a href="https://jackrabbit.apache.org/filevault/filter.html">filter rules' root attributes</a>.
+ * Currently these packages are only used to define the <a href="https://jackrabbit.apache.org/filevault/validation.html#standard-validators">{@code validRoots} of the validator {@code jackrabbit-filter}</a>.
+ */
@Parameter(property = "vault.repository.structure.packages")
protected Collection<MavenBasedPackageDependency> repositoryStructurePackages = new LinkedList<>();
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateCndMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateCndMojo.java
index d1fc8f7..5d0acdb 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateCndMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateCndMojo.java
@@ -88,7 +88,7 @@ public class GenerateCndMojo extends AbstractSourceAndMetadataPackageMojo {
* <a href="https://sling.apache.org/documentation/bundles/content-loading-jcr-contentloader.html#declared-node-type-registration">{@code Sling-Nodetypes} manifest header</a>.
* part from the <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html#URL-java.lang.String-java.lang.String-int-java.lang.String-"standard protocols</a> the scheme {@code tccl}
* can be used to reference names from the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html#getContextClassLoader--">Thread's context class loader</a>.
- * In the Maven plugin context this is the <a href="http://maven.apache.org/guides/mini/guide-maven-classloading.html?ref=driverlayer.com/web#3-plugin-classloaders">plugin classloader.
+ * In the Maven plugin context this is the <a href="http://maven.apache.org/guides/mini/guide-maven-classloading.html?ref=driverlayer.com/web#3-plugin-classloaders">plugin classloader</a>.
*/
@Parameter(property = "vault.inputCndUrls")
List<String> additionalInputCndUrls = new LinkedList<>();
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java
index f257307..c436e49 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/ValidateFilesMojo.java
@@ -98,7 +98,7 @@ public class ValidateFilesMojo extends AbstractValidateMojo {
/**
* The directory containing the metadata to be packaged up into the content package.
- * Basically containing all files/folders being generated by goal "generate-metadata".
+ * Basically containing all files/folders being generated by goal {@code generate-metadata}.
*/
@Parameter(
defaultValue = "${project.build.directory}/vault-work",