* Over {@link IArtifactProvider}, this interface adds a method for obtaining the artifacts as files
- * in the local file system. (With the IArtifactProvider interface, artifacts can only be
+ * in the local file system. (With the IArtifactProvider interface, artifacts can only be
* obtained as stream.)
*
* Over {@link IArtifactFileProvider}, this interface adds methods for obtaining artifacts in raw
- * formats. (With the IArtifactFileProvider interface, artifacts can only be obtained in
+ * formats. (With the IArtifactFileProvider interface, artifacts can only be obtained in
* the canonical format, i.e. the format in which the artifact can be used directly without
* additional decompression.)
*
* Over {@link IRawArtifactProvider}, this interface adds a method for obtaining the artifacts as
- * files in the local file system. (With the IRawArtifactProvider interface, artifacts can
+ * files in the local file system. (With the IRawArtifactProvider interface, artifacts can
* only be obtained as stream.)
*
* Over {@link IArtifactProvider}, this interface adds methods for obtaining artifacts in raw
- * formats. (With the IArtifactProvider interface, artifacts can only be obtained in the
+ * formats. (With the IArtifactProvider interface, artifacts can only be obtained in the
* canonical format, i.e. the format in which the artifact can be used directly without additional
* decompression.)
*
null if the artifact does not
- * exist in the target platform, or if the given ArtifactKey refers to an
+ * exist in the target platform, or if the given ArtifactKey refers to an
* metadata-only "artifact" e.g. a product definition.
*/
File getArtifactLocation(ArtifactKey artifact);
diff --git a/tycho-compiler-plugin/src/main/java/copied/org/apache/maven/plugin/AbstractCompilerMojo.java b/tycho-compiler-plugin/src/main/java/copied/org/apache/maven/plugin/AbstractCompilerMojo.java
index b3daec6d0c..64ad0ab32a 100644
--- a/tycho-compiler-plugin/src/main/java/copied/org/apache/maven/plugin/AbstractCompilerMojo.java
+++ b/tycho-compiler-plugin/src/main/java/copied/org/apache/maven/plugin/AbstractCompilerMojo.java
@@ -183,10 +183,10 @@ public abstract class AbstractCompilerMojo extends AbstractMojo {
private String executable;
/**
- * If only is specified, the annotation processors will run but no compilation will be
- * performed. If none is specified, annotation processors will not be discovered or
+ * If only is specified, the annotation processors will run but no compilation will be
+ * performed. If none is specified, annotation processors will not be discovered or
* run; compilation will proceed as if no annotation processors were found. By default the
- * compiler must search the classpath for annotation processors, so specifying none may
+ * compiler must search the classpath for annotation processors, so specifying none may
* speed compilation if annotation processing is not required. This parameter requires a 1.6 VM
* or above and is used only if the compliance is 1.6
*
diff --git a/tycho-compiler-plugin/src/main/java/org/eclipse/tycho/compiler/AbstractOsgiCompilerMojo.java b/tycho-compiler-plugin/src/main/java/org/eclipse/tycho/compiler/AbstractOsgiCompilerMojo.java
index a169332e78..d5e0569940 100644
--- a/tycho-compiler-plugin/src/main/java/org/eclipse/tycho/compiler/AbstractOsgiCompilerMojo.java
+++ b/tycho-compiler-plugin/src/main/java/org/eclipse/tycho/compiler/AbstractOsgiCompilerMojo.java
@@ -167,7 +167,7 @@ public abstract class AbstractOsgiCompilerMojo extends AbstractCompilerMojo impl
*
*
* The default value of the bootclasspath used for compilation is
- * <jdkHome>/lib/*;<jdkHome>/lib/ext/*;<jdkHome>/lib/endorsed/* .
+ * <jdkHome>/lib/*;<jdkHome>/lib/ext/*;<jdkHome>/lib/endorsed/* .
*
* For JDKs with different filesystem layouts, the bootclasspath can be specified explicitly in
* the configuration section.
diff --git a/tycho-core/src/main/java/org/eclipse/tycho/core/TychoProjectManager.java b/tycho-core/src/main/java/org/eclipse/tycho/core/TychoProjectManager.java
index 5abc26e29e..1a62e62630 100644
--- a/tycho-core/src/main/java/org/eclipse/tycho/core/TychoProjectManager.java
+++ b/tycho-core/src/main/java/org/eclipse/tycho/core/TychoProjectManager.java
@@ -59,6 +59,7 @@
import org.eclipse.tycho.core.osgitools.OsgiManifest;
import org.eclipse.tycho.core.osgitools.OsgiManifestParserException;
import org.eclipse.tycho.core.resolver.DefaultTargetPlatformConfigurationReader;
+import org.eclipse.tycho.core.resolver.shared.IncludeSourceMode;
import org.eclipse.tycho.helper.PluginRealmHelper;
import org.eclipse.tycho.model.project.EclipseProject;
import org.eclipse.tycho.targetplatform.TargetDefinition;
@@ -161,6 +162,10 @@ private Map<name>-<version>, with name not containing dashes (-) and version being a
* valid OSGi version.
*/
public class InvalidEENameException extends RuntimeException {
diff --git a/tycho-core/src/main/java/org/eclipse/tycho/core/resolver/DefaultTargetPlatformConfigurationReader.java b/tycho-core/src/main/java/org/eclipse/tycho/core/resolver/DefaultTargetPlatformConfigurationReader.java
index c9cd9d6863..dceb0cc3ac 100644
--- a/tycho-core/src/main/java/org/eclipse/tycho/core/resolver/DefaultTargetPlatformConfigurationReader.java
+++ b/tycho-core/src/main/java/org/eclipse/tycho/core/resolver/DefaultTargetPlatformConfigurationReader.java
@@ -332,7 +332,7 @@ private void setBREEHeaderSelectionPolicy(TargetPlatformConfiguration result, Xp
/**
* Take the constraints of the configured execution environment into account when resolving
* dependencies or target definitions. These constraints include the list of system packages and
- * the Bundle-RequiredExecutionEnvironment header. When set to true, the
+ * the Bundle-RequiredExecutionEnvironment header. When set to true, the
* dependency resolution verifies that the bundle and all required bundles can be used in an
* OSGi container with the configured execution environment.
*/
diff --git a/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/MirroringArtifactProvider.java b/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/MirroringArtifactProvider.java
index 055afd5751..0bb2945664 100644
--- a/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/MirroringArtifactProvider.java
+++ b/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/MirroringArtifactProvider.java
@@ -61,7 +61,7 @@
* repository.
*
*
- * Note that a MirroringArtifactProvider is not a transparent cache of the remote
+ * Note that a MirroringArtifactProvider is not a transparent cache of the remote
* providers. The content provided by this instance differs from the remote providers' content in
* the following ways:
*
p2artifacts.xml file in the given build target directory, which contains a list of
* all artifacts with p2 and Maven coordinates. (In particular the classifier part of the
* Maven coordinates is relevant.) This file is deployed to Maven repositories alongside with the
* built Tycho artifact.p2content.xml. The
+ * p2content.xml is the file that is deployed to Maven repositories alongside with the
* built Tycho artifact.
*
* @see TychoConstants#FILE_NAME_P2_METADATA
diff --git a/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/streaming/ArtifactSinkFactory.java b/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/streaming/ArtifactSinkFactory.java
index 87945c39df..a1ff768c21 100644
--- a/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/streaming/ArtifactSinkFactory.java
+++ b/tycho-core/src/main/java/org/eclipse/tycho/p2/repository/streaming/ArtifactSinkFactory.java
@@ -34,7 +34,7 @@ public final class ArtifactSinkFactory {
* The key of the artifact to be written.
* @param destination
* The output stream to write the artifact content to. The ownership of the stream is
- * not transferred, i.e. neither this method nor the returned IArtifactSink
+ * not transferred, i.e. neither this method nor the returned IArtifactSink
* will call {@link OutputStream#close()} on the stream.
*/
public static IArtifactSink writeToStream(IArtifactKey artifactKey, OutputStream destination) {
@@ -55,7 +55,7 @@ public static IArtifactSink writeToStream(IArtifactKey artifactKey, OutputStream
* An {@link IArtifactDescriptor} specifying artifact and format to be written.
* @param destination
* The output stream to write the raw content to. The ownership of the stream is not
- * transferred, i.e. neither this method nor the returned IRawArtifactSink
+ * transferred, i.e. neither this method nor the returned IRawArtifactSink
* will call {@link OutputStream#close()} on the stream.
*/
public static IRawArtifactSink rawWriteToStream(IArtifactDescriptor artifactDescriptor, OutputStream destination) {
diff --git a/tycho-core/src/main/java/org/eclipse/tycho/p2/tools/director/shared/AbstractDirectorApplicationCommand.java b/tycho-core/src/main/java/org/eclipse/tycho/p2/tools/director/shared/AbstractDirectorApplicationCommand.java
index 965d526ddd..6d59f72409 100644
--- a/tycho-core/src/main/java/org/eclipse/tycho/p2/tools/director/shared/AbstractDirectorApplicationCommand.java
+++ b/tycho-core/src/main/java/org/eclipse/tycho/p2/tools/director/shared/AbstractDirectorApplicationCommand.java
@@ -14,10 +14,10 @@
import java.io.File;
import java.net.URI;
-import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringJoiner;
+import java.util.TreeMap;
import java.util.stream.Collectors;
import org.eclipse.equinox.p2.engine.IPhaseSet;
@@ -45,6 +45,7 @@ public abstract class AbstractDirectorApplicationCommand implements DirectorRunt
private File destination;
private File bundlePool;
private IPhaseSet phaseSet;
+ private boolean installSources;
@Override
public final void addMetadataSources(Iterable* The javadoc executable path is determined in this order: *
executable argument of the javadocOptions configuration
* element, if availablejava.home system propertyJAVA_HOME environment settingignoreError, specifies if errors calling javadoc should be
* ignoreddoclet, used as javadoc -doclet parameterdocletArtifacts, dependencies will be resovled and added as
+ * -docletpath parameterencoding, used as javadoc -encoding parameter (default:
+ * ${project.build.sourceEncoding}additionalArguments, a list of additional arguments passed to
* javadocincludes/excludes, the list of names of packages to be
+ * included in or excluded from JavaDoc processing; use '*' character
* as wildcardexecutable, the javadoc executable path to be used (see mojo
* description for the default path calculation)mainLabel, specifies the main label of the toc file (default:
* "API Reference")mainFilename, specifies the filename of the TOC file (default:
* "overview-summary.html")
*
* If the project contains more than one product file, you need to choose for which ones you
* want to create distribution archives. If you choose to install more than one product, you
- * need to specify the attachId (which becomes a part of the classifier) to make the
+ * need to specify the attachId (which becomes a part of the classifier) to make the
* classifiers unique. Example:
*
*
@@ -98,11 +98,11 @@ abstract class AbstractProductMojo extends AbstractMojo {
*
* Details on the product-specific configuration parameters:
* rootFolder - The path where the installed product shall be stored in the
* archive, e.g. "eclipse". By default, the product is stored in the archive root.rootFolders - OS-specific installation root folders, overriding
+ * rootFolder. Allowed children are <macosx>, <win32>,
+ * <linux> and <freebsd> or any other OS supported by p2. Since
* 0.18.0org.eclipse.update.install.features=true to install the
* features into the product.
*/
@Parameter(property = "profileproperties")
@@ -227,6 +227,9 @@ public class DirectorMojo extends AbstractMojo {
@Parameter(property = "installFeatures", defaultValue = "true")
private boolean installFeatures;
+ @Parameter(defaultValue = "false")
+ private boolean installSources;
+
/**
* Additional profile properties to set when materializing the product
*/
@@ -473,6 +476,9 @@ private Maporg.eclipse.update.install.features to true in the p2 profile.)
*/
@Parameter(defaultValue = "true")
private boolean installFeatures;
+ /**
+ * Include the sources of JARs in installation. (Technically, this sets the property
+ * org.eclipse.update.install.sources to true in the p2 profile.)
+ */
+ @Parameter(defaultValue = "false")
+ private boolean installSources;
+
/**
* Additional profile properties to set when materializing the product
*/
@@ -93,7 +100,7 @@ public enum DirectorRuntimeType {
* Source repositories to be used in the director calls. Can be:
* targetPlatform - to use the target platform as source (default)repository - to use the p2 repository in target/repository/ as
+ * repository - to use the p2 repository in target/repository/ as
* source. With this option, the build implicitly verifies that it would also be possible to
* install the product from that repository with an external director application.
* osgi.os
* environment values as keys. Has precedence over rootFolder.
*/
private Map
- * Publishes the category definitions from the category.xml in the root of the project.
+ * Publishes the category definitions from the category.xml in the root of the project.
*
- * Publishes all product definitions files (*.product) that are present in the root of the
+ * Publishes all product definitions files (*.product) that are present in the root of the
* project.
*
- * Compress the repository index files content.xml and artifacts.xml.
+ * Compress the repository index files content.xml and artifacts.xml.
*
target/ directory.
*/
@Parameter(property = "project.build.directory")
private File outputDirectory;
@@ -270,8 +270,8 @@ private void appendToOrAddFeatureProperties(File targetFeatureProperties, File l
}
/**
- * @return A {@link FileSet} including files as configured by the bin.includes and
- * bin.excludes properties without the files that are always included
+ * @return A {@link FileSet} including files as configured by the bin.includes and
+ * bin.excludes properties without the files that are always included
* automatically.
*/
private FileSet getManuallyIncludedFiles(BuildProperties buildProperties) {
diff --git a/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/OsgiSourceMojo.java b/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/OsgiSourceMojo.java
index 3d8bc644ef..257e3cffb4 100644
--- a/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/OsgiSourceMojo.java
+++ b/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/OsgiSourceMojo.java
@@ -137,8 +137,8 @@ public class OsgiSourceMojo extends AbstractSourceJarMojo {
/**
* Additional files to be included in the source bundle jar. This can be used when
- * src.includes in build.properties is not flexible enough , e.g. for files which would
- * otherwise conflict with files in bin.includessrc.includes in build.properties is not flexible enough , e.g. for files which would
+ * otherwise conflict with files in bin.includes
diff --git a/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/SourceFeatureMojo.java b/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/SourceFeatureMojo.java
index 67d3b6c290..0ef867fad2 100644
--- a/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/SourceFeatureMojo.java
+++ b/tycho-source-plugin/src/main/java/org/eclipse/tycho/source/SourceFeatureMojo.java
@@ -646,8 +646,8 @@ private String getAttribute(PlexusConfiguration dom, String attrName) {
}
/**
- * @return A {@link FileSet} including files as configured by the src.includes and
- * src.excludes properties without the files that are always included
+ * @return A {@link FileSet} including files as configured by the src.includes and
+ * src.excludes properties without the files that are always included
* automatically.
*/
private FileSet getManuallyIncludedFiles(File basedir, BuildProperties buildProperties) {
diff --git a/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/AbstractEclipseTestMojo.java b/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/AbstractEclipseTestMojo.java
index 5e880ad396..092ee9d7a4 100644
--- a/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/AbstractEclipseTestMojo.java
+++ b/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/AbstractEclipseTestMojo.java
@@ -429,7 +429,7 @@ public abstract class AbstractEclipseTestMojo extends AbstractTestMojo {
* when installing products under test (see below).
* default mode, all necessary files to define the test runtime like
- * config.ini are generated by tycho. This installation mode has the advantage that the
+ * config.ini are generated by tycho. This installation mode has the advantage that the
* test runtime is minimal (defined by the transitive dependencies of the test bundle plus and
* the test harness) and existing bundle jars are referenced rather than copied for the
* installationextraRequirements on the
+ * target-platform-configuration plugin instead. Example:
*
*
* <plugin>
@@ -502,8 +502,8 @@ public abstract class AbstractEclipseTestMojo extends AbstractTestMojo {
* </plugin>
*
*
- * The dependencies specified as extraRequirements are – together with the
- * dependencies specified in the MANIFEST.MF of the project – transitively
+ * The dependencies specified as extraRequirements are – together with the
+ * dependencies specified in the MANIFEST.MF of the project – transitively
* resolved against the target platform. The resulting set of bundles is included in the test
* runtime.
*/
diff --git a/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TestPluginMojo.java b/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TestPluginMojo.java
index bc8259f8ff..336702e3db 100644
--- a/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TestPluginMojo.java
+++ b/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TestPluginMojo.java
@@ -35,9 +35,9 @@
* runtime" consists of the bundle built in this project and its transitive dependencies, plus some
* Equinox and test harness bundles. The bundles are resolved from the target platform of the
* project. Note that the test runtime does typically not contain the entire target
- * platform. If there are implicitly required bundles (e.g. org.apache.felix.scr to make
- * declarative services work), they need to be added manually through an extraRequirements
- * configuration on the target-platform-configuration plugin.
+ * platform. If there are implicitly required bundles (e.g. org.apache.felix.scr to make
+ * declarative services work), they need to be added manually through an extraRequirements
+ * configuration on the target-platform-configuration plugin.
*
*/
@Mojo(name = "test", defaultPhase = LifecyclePhase.INTEGRATION_TEST, requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true)
diff --git a/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TychoIntegrationTestMojo.java b/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TychoIntegrationTestMojo.java
index bf4ddaa215..9b8796219b 100644
--- a/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TychoIntegrationTestMojo.java
+++ b/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/TychoIntegrationTestMojo.java
@@ -49,9 +49,9 @@
* the bundle built in this project and its transitive dependencies, plus some Equinox and test
* harness bundles. The bundles are resolved from the target platform of the project. Note that the
* test runtime does typically not contain the entire target platform. If there are
- * implicitly required bundles (e.g. org.apache.felix.scr to make declarative services
- * work), they need to be added manually through an extraRequirements configuration on the
- * target-platform-configuration plugin.
+ * implicitly required bundles (e.g. org.apache.felix.scr to make declarative services
+ * work), they need to be added manually through an extraRequirements configuration on the
+ * target-platform-configuration plugin.
*
*
* This goal adopts the maven-failsafe paradigm, that works in the following way:
diff --git a/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetDefinition.java b/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetDefinition.java
index e700d90ce2..1a0683df41 100644
--- a/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetDefinition.java
+++ b/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetDefinition.java
@@ -34,7 +34,7 @@ public interface TargetDefinition {
/**
* Returns true if the target definition specifies an explicit list
- * of bundles to include (i.e. an <includeBundles> in target
+ * of bundles to include (i.e. an <includeBundles> in target
* definition files).
*/
boolean hasIncludedBundles();
diff --git a/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetPlatformFilter.java b/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetPlatformFilter.java
index 9ccb1c2918..9c020ba6c9 100644
--- a/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetPlatformFilter.java
+++ b/tycho-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetPlatformFilter.java
@@ -58,8 +58,8 @@ public FilterAction getAction() {
*
* If the action pattern returns null for its type, or type and id attributes,
* these values shall be inherited from the scope pattern. This ensures that filters with a
- * short <restrictTo> pattern with only a single <version> or
- * <versionRange> attribute work as expected.
+ * short <restrictTo> pattern with only a single <version> or
+ * <versionRange> attribute work as expected.
*
maven-properties-plugin to capture the values in a file called
* baseTest.properties (see tycho-its/pom.xml for an example).
*/
public class EnvironmentUtil {
diff --git a/tycho-testing-harness/src/main/java/org/eclipse/tycho/test/util/P2RepositoryTool.java b/tycho-testing-harness/src/main/java/org/eclipse/tycho/test/util/P2RepositoryTool.java
index b3151eec01..5369ac8697 100644
--- a/tycho-testing-harness/src/main/java/org/eclipse/tycho/test/util/P2RepositoryTool.java
+++ b/tycho-testing-harness/src/main/java/org/eclipse/tycho/test/util/P2RepositoryTool.java
@@ -158,7 +158,7 @@ public ListunitId.
*/
public IU getUniqueIU(String unitId) throws Exception {
loadMetadata();
diff --git a/tycho-versions-plugin/src/main/java/org/eclipse/tycho/versions/SetVersionMojo.java b/tycho-versions-plugin/src/main/java/org/eclipse/tycho/versions/SetVersionMojo.java
index 1a459965ea..9a15da6ff7 100644
--- a/tycho-versions-plugin/src/main/java/org/eclipse/tycho/versions/SetVersionMojo.java
+++ b/tycho-versions-plugin/src/main/java/org/eclipse/tycho/versions/SetVersionMojo.java
@@ -41,17 +41,17 @@
* eclipse-plugin project is changed and the plugin exports a package with a
* version which is the same as the unqualified project version, the version of the package is also
* changed.
- * eclipse-plugin
* that changed version will be updated:
* eclipse-repository project is changed and a product file in the project has
* an equivalent version, the version in the product file is also changed.