Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonah Graham2019-06-27 14:26:27 -0400
committerJonah Graham2019-06-27 14:35:29 -0400
commit7cae7fb332dd6b294fecf876ca6e27a763dd3591 (patch)
tree1a0e7b5bdea691b81ab3a4a8317c4829bf3746ad
parent1cbadbf132eb86a8e6726593359a75de01796663 (diff)
downloadorg.eclipse.tycho-7cae7fb332dd6b294fecf876ca6e27a763dd3591.tar.gz
org.eclipse.tycho-7cae7fb332dd6b294fecf876ca6e27a763dd3591.tar.xz
org.eclipse.tycho-7cae7fb332dd6b294fecf876ca6e27a763dd3591.zip
Bug 548726: Document enums in tycho-p2-plugin
Change-Id: If8b280bc9976e509f6a794e9143c6f3feb8d4d99 Signed-off-by: Jonah Graham <jonah@kichwacoders.com>
-rw-r--r--tycho-p2/tycho-p2-plugin/src/main/java/org/eclipse/tycho/plugins/p2/P2MetadataMojo.java23
1 files changed, 21 insertions, 2 deletions
diff --git a/tycho-p2/tycho-p2-plugin/src/main/java/org/eclipse/tycho/plugins/p2/P2MetadataMojo.java b/tycho-p2/tycho-p2-plugin/src/main/java/org/eclipse/tycho/plugins/p2/P2MetadataMojo.java
index 9ec8b0b4d..d2d51cdae 100644
--- a/tycho-p2/tycho-p2-plugin/src/main/java/org/eclipse/tycho/plugins/p2/P2MetadataMojo.java
+++ b/tycho-p2/tycho-p2-plugin/src/main/java/org/eclipse/tycho/plugins/p2/P2MetadataMojo.java
@@ -90,13 +90,32 @@ public class P2MetadataMojo extends AbstractMojo {
private List<Repository> baselineRepositories;
/**
- * What happens when build artifact does not match baseline version.
+ * What happens when build artifact does not match baseline version:
+ * <ul>
+ * <li><code>disable</code>: Disable baseline validation.</li>
+ * <li><code>warn</code> (default): Warn about discrepancies between build and baseline
+ * artifacts but do not fail the build.</li>
+ * <li><code>failCommon</code>: Fail the build if there are discrepancies between artifacts
+ * present both in build and baseline. Attached artifacts only present in the build do not
+ * result in build failure.</li>
+ * <li><code>fail</code>: Fail the build if there are any discrepancy between build and baseline
+ * artifacts.</li>
+ * </ul>
*/
@Parameter(property = "tycho.baseline", defaultValue = "warn")
private BaselineMode baselineMode;
/**
- * Whether to replace build artifacts with baseline version or use reactor version.
+ * Whether to replace build artifacts with baseline version or use reactor version:
+ * <ul>
+ * <li><code>none</code>: Do not replace build artifacts with baseline version.</li>
+ * <li><code>common</code>: Replace build artifacts with baseline version. Attached artifacts
+ * only present in the build are not removed and will likely result in inconsistencies among
+ * artifacts of the same project! Use as last resort when baseline does not contain all build
+ * artifacts.</li>
+ * <li><code>all</code> (default): Replace build artifacts with baseline version. Attached
+ * artifacts only present in the build are removed.</li>
+ * </ul>
*/
@Parameter(property = "tycho.baseline.replace", defaultValue = "all")
private BaselineReplace baselineReplace;

Back to the top