blob: 9a0b629ec98388f2e3d8d54a1549ac11d05c8e94 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.9.1 from target/generated-site/xdoc/plugin-source-mojo.xml at 2020-04-06
| Rendered using Apache Maven Fluido Skin 1.8
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.1" />
<title>Tycho OSGi Source Plugin &#x2013; tycho-source:plugin-source</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.8.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-1.8.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<header>
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Tycho OSGi Source Plugin</h2>
</div>
</div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2020-04-06<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.7.0</li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Tycho</li>
<li><a href="../index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
<li><a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"><span class="none"></span>Compiler Plugin</a></li>
<li><a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin"><span class="none"></span>Packaging Plugin</a></li>
<li><a href="../tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin"><span class="none"></span>Surefire Plugin</a></li>
<li><a href="../tycho-p2/tycho-p2-publisher-plugin/plugin-info.html" title="p2 Publisher Plugin"><span class="none"></span>p2 Publisher Plugin</a></li>
<li><a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="p2 Repository Plugin"><span class="none"></span>p2 Repository Plugin</a></li>
<li><a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="p2 Director Plugin"><span class="none"></span>p2 Director Plugin</a></li>
<li><a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin"><span class="none"></span>Source Plugin</a></li>
<li><a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin"><span class="none"></span>Versions Plugin</a></li>
<li><a href="../tycho-pomgenerator-plugin/plugin-info.html" title="POM Generator Plugin"><span class="none"></span>POM Generator Plugin</a></li>
<li><a href="" title="Properties"><span class="icon-chevron-down"></span>Properties</a>
<ul class="nav nav-list">
<li><a href="../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li>
<li><a href="../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li>
</ul></li>
<li class="nav-header">Tycho Extras</li>
<li><a href="../tycho-extras/index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
<li><a href="../tycho-extras/tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin"><span class="none"></span>P2 Extras Plugin</a></li>
<li><a href="../tycho-extras/target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin"><span class="none"></span>Target Platform Validation Plugin</a></li>
<li><a href="../tycho-extras/tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin"><span class="none"></span>Eclipserun Plugin</a></li>
<li><a href="../tycho-extras/tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin"><span class="none"></span>Document Bundle Plugin</a></li>
<li><a href="../tycho-extras/tycho-source-feature-plugin/plugin-info.html" title="Source Feature Generation Plugin"><span class="none"></span>Source Feature Generation Plugin</a></li>
<li><a href="../tycho-extras/tycho-pack200/index.html" title="Pack200 Plugins"><span class="icon-chevron-down"></span>Pack200 Plugins</a>
<ul class="nav nav-list">
<li><a href="../tycho-extras/tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin"><span class="none"></span>Normalization Plugin</a></li>
<li><a href="../tycho-extras/tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin"><span class="none"></span>Pack Plugin</a></li>
</ul></li>
</ul>
</nav>
<div class="well sidebar-nav">
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span10" >
<section>
<h2><a name="tycho-source:plugin-source"></a>tycho-source:plugin-source</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho:tycho-source-plugin:1.7.0:plugin-source</p>
<p><b>Description</b>:</p>
<div>Goal to create a JAR-package containing all the source files of a
osgi project.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Since version: 2.0.3.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: prepare-package.</li>
</ul>
<section>
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><a href="#additionalFileSets">&lt;additionalFileSets&gt;</a></td>
<td>DefaultFileSet[]</td>
<td>2.0.3</td>
<td>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.includes<br />
Example:<br />
<div>
<pre>
&lt;additionalFileSets&gt;
&lt;fileSet&gt;
&lt;directory&gt;${project.basedir}/sourceIncludes/&lt;/directory&gt;
&lt;includes&gt;
&lt;include&gt;**/*&lt;/include&gt;
&lt;/includes&gt;
&lt;/fileSet&gt;
&lt;/additionalFileSets&gt;
</pre></div><br /></td>
</tr>
<tr class="a">
<td><a href="#archive">&lt;archive&gt;</a></td>
<td>MavenArchiveConfiguration</td>
<td>2.1</td>
<td>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html">Maven
Archiver Reference</a>.<br /></td>
</tr>
<tr class="b">
<td><a href="#attach">&lt;attach&gt;</a></td>
<td>boolean</td>
<td>2.0.3</td>
<td>Specifies whether or not to attach the artifact to the project<br /><b>Default value is</b>: true.<br /><b>User property is</b>: attach.<br /></td>
</tr>
<tr class="a">
<td><a href="#classifier">&lt;classifier&gt;</a></td>
<td>String</td>
<td>2.0.3</td>
<td>The source bundles classifier. The name of the source bundle will
be finalName- classifier.jar<br /><b>Default value is</b>: sources.<br /></td>
</tr>
<tr class="b">
<td><a href="#distinctSourceRoots">&lt;distinctSourceRoots&gt;</a></td>
<td>boolean</td>
<td>2.0.3</td>
<td>Whether sources for nested jars should be put into distinct source
root folders inside the source jar (one source root per nested
jar). E.g. if this paramater is true and there is a
nested jar named foo.jar, all of its sources will go
into folder foosrc/. Otherwise all sources for all
jars, nested or not, will go into the root of the source jar (this
is the default as it provides interoperability with maven source
jars).<br /><b>Default value is</b>: false.<br /></td>
</tr>
<tr class="a">
<td><a href="#excludeResources">&lt;excludeResources&gt;</a></td>
<td>boolean</td>
<td>2.0.4</td>
<td>Specifies whether or not to exclude resources from the sources-jar.
This can be convenient if your project includes large resources,
such as images, and you don't want to include them in the
sources-jar.<br /><b>Default value is</b>: false.<br /><b>User property is</b>: source.excludeResources.<br /></td>
</tr>
<tr class="b">
<td><a href="#excludes">&lt;excludes&gt;</a></td>
<td>String[]</td>
<td>2.1</td>
<td>List of files to exclude. Specified as fileset patterns which are
relative to the input directory whose contents is being packaged
into the JAR.<br /></td>
</tr>
<tr class="a">
<td><a href="#finalName">&lt;finalName&gt;</a></td>
<td>String</td>
<td>2.0.3</td>
<td>The filename to be used for the generated archive file. For the
source:jar goal, &quot;-sources&quot; is appended to this filename. For the
source:test-jar goal, &quot;-test-sources&quot; is appended.<br /><b>User property is</b>: project.build.finalName.<br /></td>
</tr>
<tr class="b">
<td><a href="#forceCreation">&lt;forceCreation&gt;</a></td>
<td>boolean</td>
<td>2.1</td>
<td>NOT SUPPORTED. Whether creating the archive should be forced. If
set to true, the jar will always be created. If set to false, the
jar will only be created when the sources are newer than the jar.<br /><b>Default value is</b>: false.<br /><b>User property is</b>: source.forceCreation.<br /></td>
</tr>
<tr class="a">
<td><a href="#includePom">&lt;includePom&gt;</a></td>
<td>boolean</td>
<td>2.1</td>
<td>Specifies whether or not to include the POM file in the
sources-jar.<br /><b>Default value is</b>: false.<br /><b>User property is</b>: source.includePom.<br /></td>
</tr>
<tr class="b">
<td><a href="#includes">&lt;includes&gt;</a></td>
<td>String[]</td>
<td>2.1</td>
<td>List of files to include. Specified as fileset patterns which are
relative to the input directory whose contents is being packaged
into the JAR.<br /></td>
</tr>
<tr class="a">
<td><a href="#outputDirectory">&lt;outputDirectory&gt;</a></td>
<td>File</td>
<td>2.0.3</td>
<td>The directory where the generated archive file will be put.<br /><b>User property is</b>: project.build.directory.<br /></td>
</tr>
<tr class="b">
<td><a href="#qualifier">&lt;qualifier&gt;</a></td>
<td>String</td>
<td>2.0.3</td>
<td>Build qualifier. Recommended way to set this parameter is using
build-qualifier goal. Only used when creating a source bundle.<br /><b>User property is</b>: buildQualifier.<br /></td>
</tr>
<tr class="a">
<td><a href="#sourceBundle">&lt;sourceBundle&gt;</a></td>
<td>boolean</td>
<td>2.0.3</td>
<td>Whether the source jar should be an Eclipse source bundle.<br /><b>Default value is</b>: true.<br /></td>
</tr>
<tr class="b">
<td><a href="#sourceBundleSuffix">&lt;sourceBundleSuffix&gt;</a></td>
<td>String</td>
<td>2.0.3</td>
<td>The suffix to be added to the symbolic name of the bundle to
construct the symbolic name of the Eclipse source bundle.<br /><b>Default value is</b>: .source.<br /><b>User property is</b>: sourceBundleSuffix.<br /></td>
</tr>
<tr class="a">
<td><a href="#strictSrcIncludes">&lt;strictSrcIncludes&gt;</a></td>
<td>boolean</td>
<td>2.0.3</td>
<td>If set to true (the default), missing build.properties
src.includes will cause build failure. If set to
false, missing build.properties src.includes will be
reported as warnings but the build will not fail.<br /><b>Default value is</b>: true.<br /></td>
</tr>
<tr class="b">
<td><a href="#useDefaultExcludes">&lt;useDefaultExcludes&gt;</a></td>
<td>boolean</td>
<td>2.1</td>
<td>Exclude commonly excluded files such as SCM configuration. These
are defined in the plexus FileUtils.getDefaultExcludes()<br /><b>Default value is</b>: true.<br /></td>
</tr>
<tr class="a">
<td><a href="#useDefaultManifestFile">&lt;useDefaultManifestFile&gt;</a></td>
<td>boolean</td>
<td>2.1</td>
<td>Set this to true to enable the use of the
defaultManifestFile. <br /><br /><b>Default value is</b>: false.<br /></td>
</tr>
<tr class="b">
<td><a href="#useDefaultSourceExcludes">&lt;useDefaultSourceExcludes&gt;</a></td>
<td>boolean</td>
<td>2.0.3</td>
<td>Whether default source excludes for SCM files defined in
AbstractScanner#DEFAULTEXCLUDES should be used.<br /><b>Default value is</b>: true.<br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<section>
<h4><a name="a.3CadditionalFileSets.3E"></a><b><a name="additionalFileSets">&lt;additionalFileSets&gt;</a></b></h4>
<div>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.includes<br />
Example:<br />
<div>
<pre>
&lt;additionalFileSets&gt;
&lt;fileSet&gt;
&lt;directory&gt;${project.basedir}/sourceIncludes/&lt;/directory&gt;
&lt;includes&gt;
&lt;include&gt;**/*&lt;/include&gt;
&lt;/includes&gt;
&lt;/fileSet&gt;
&lt;/additionalFileSets&gt;
</pre></div></div>
<ul>
<li><b>Type</b>: org.codehaus.plexus.archiver.util.DefaultFileSet[]</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
</ul><hr /></section><section>
<h4><a name="a.3Carchive.3E"></a><b><a name="archive">&lt;archive&gt;</a></b></h4>
<div>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html">Maven
Archiver Reference</a>.</div>
<ul>
<li><b>Type</b>: org.apache.maven.archiver.MavenArchiveConfiguration</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
</ul><hr /></section><section>
<h4><a name="a.3Cattach.3E"></a><b><a name="attach">&lt;attach&gt;</a></b></h4>
<div>Specifies whether or not to attach the artifact to the project</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: attach</li>
<li><b>Default</b>: true</li>
</ul><hr /></section><section>
<h4><a name="a.3Cclassifier.3E"></a><b><a name="classifier">&lt;classifier&gt;</a></b></h4>
<div>The source bundles classifier. The name of the source bundle will
be finalName- classifier.jar</div>
<ul>
<li><b>Type</b>: java.lang.String</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: sources</li>
</ul><hr /></section><section>
<h4><a name="a.3CdistinctSourceRoots.3E"></a><b><a name="distinctSourceRoots">&lt;distinctSourceRoots&gt;</a></b></h4>
<div>Whether sources for nested jars should be put into distinct source
root folders inside the source jar (one source root per nested
jar). E.g. if this paramater is true and there is a
nested jar named foo.jar, all of its sources will go
into folder foosrc/. Otherwise all sources for all
jars, nested or not, will go into the root of the source jar (this
is the default as it provides interoperability with maven source
jars).</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: false</li>
</ul><hr /></section><section>
<h4><a name="a.3CexcludeResources.3E"></a><b><a name="excludeResources">&lt;excludeResources&gt;</a></b></h4>
<div>Specifies whether or not to exclude resources from the sources-jar.
This can be convenient if your project includes large resources,
such as images, and you don't want to include them in the
sources-jar.</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.0.4</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: source.excludeResources</li>
<li><b>Default</b>: false</li>
</ul><hr /></section><section>
<h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes">&lt;excludes&gt;</a></b></h4>
<div>List of files to exclude. Specified as fileset patterns which are
relative to the input directory whose contents is being packaged
into the JAR.</div>
<ul>
<li><b>Type</b>: java.lang.String[]</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
</ul><hr /></section><section>
<h4><a name="a.3CfinalName.3E"></a><b><a name="finalName">&lt;finalName&gt;</a></b></h4>
<div>The filename to be used for the generated archive file. For the
source:jar goal, &quot;-sources&quot; is appended to this filename. For the
source:test-jar goal, &quot;-test-sources&quot; is appended.</div>
<ul>
<li><b>Type</b>: java.lang.String</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: project.build.finalName</li>
</ul><hr /></section><section>
<h4><a name="a.3CforceCreation.3E"></a><b><a name="forceCreation">&lt;forceCreation&gt;</a></b></h4>
<div>NOT SUPPORTED. Whether creating the archive should be forced. If
set to true, the jar will always be created. If set to false, the
jar will only be created when the sources are newer than the jar.</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: source.forceCreation</li>
<li><b>Default</b>: false</li>
</ul><hr /></section><section>
<h4><a name="a.3CincludePom.3E"></a><b><a name="includePom">&lt;includePom&gt;</a></b></h4>
<div>Specifies whether or not to include the POM file in the
sources-jar.</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: source.includePom</li>
<li><b>Default</b>: false</li>
</ul><hr /></section><section>
<h4><a name="a.3Cincludes.3E"></a><b><a name="includes">&lt;includes&gt;</a></b></h4>
<div>List of files to include. Specified as fileset patterns which are
relative to the input directory whose contents is being packaged
into the JAR.</div>
<ul>
<li><b>Type</b>: java.lang.String[]</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
</ul><hr /></section><section>
<h4><a name="a.3CoutputDirectory.3E"></a><b><a name="outputDirectory">&lt;outputDirectory&gt;</a></b></h4>
<div>The directory where the generated archive file will be put.</div>
<ul>
<li><b>Type</b>: java.io.File</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: project.build.directory</li>
</ul><hr /></section><section>
<h4><a name="a.3Cqualifier.3E"></a><b><a name="qualifier">&lt;qualifier&gt;</a></b></h4>
<div>Build qualifier. Recommended way to set this parameter is using
build-qualifier goal. Only used when creating a source bundle.</div>
<ul>
<li><b>Type</b>: java.lang.String</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: buildQualifier</li>
</ul><hr /></section><section>
<h4><a name="a.3CsourceBundle.3E"></a><b><a name="sourceBundle">&lt;sourceBundle&gt;</a></b></h4>
<div>Whether the source jar should be an Eclipse source bundle.</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: true</li>
</ul><hr /></section><section>
<h4><a name="a.3CsourceBundleSuffix.3E"></a><b><a name="sourceBundleSuffix">&lt;sourceBundleSuffix&gt;</a></b></h4>
<div>The suffix to be added to the symbolic name of the bundle to
construct the symbolic name of the Eclipse source bundle.</div>
<ul>
<li><b>Type</b>: java.lang.String</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: sourceBundleSuffix</li>
<li><b>Default</b>: .source</li>
</ul><hr /></section><section>
<h4><a name="a.3CstrictSrcIncludes.3E"></a><b><a name="strictSrcIncludes">&lt;strictSrcIncludes&gt;</a></b></h4>
<div>If set to true (the default), missing build.properties
src.includes will cause build failure. If set to
false, missing build.properties src.includes will be
reported as warnings but the build will not fail.</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: true</li>
</ul><hr /></section><section>
<h4><a name="a.3CuseDefaultExcludes.3E"></a><b><a name="useDefaultExcludes">&lt;useDefaultExcludes&gt;</a></b></h4>
<div>Exclude commonly excluded files such as SCM configuration. These
are defined in the plexus FileUtils.getDefaultExcludes()</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: true</li>
</ul><hr /></section><section>
<h4><a name="a.3CuseDefaultManifestFile.3E"></a><b><a name="useDefaultManifestFile">&lt;useDefaultManifestFile&gt;</a></b></h4>
<div>Set this to true to enable the use of the
defaultManifestFile. <br /></div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.1</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: false</li>
</ul><hr /></section><section>
<h4><a name="a.3CuseDefaultSourceExcludes.3E"></a><b><a name="useDefaultSourceExcludes">&lt;useDefaultSourceExcludes&gt;</a></b></h4>
<div>Whether default source excludes for SCM files defined in
AbstractScanner#DEFAULTEXCLUDES should be used.</div>
<ul>
<li><b>Type</b>: boolean</li>
<li><b>Since</b>: 2.0.3</li>
<li><b>Required</b>: No</li>
<li><b>Default</b>: true</li>
</ul>
</section></section>
</section>
</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &#169; 2008&#x2013;2020<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
.</p>
</div>
</div>
</footer>
</body>
</html>