blob: fcb476bea97f37314945a99e3c71c76ee823be11 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Oct 15, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
tycho-packaging:build-qualifier-aggregator</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20121015" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<div id="bannerLeft">
Tycho OSGi Packaging Plugin (Incubation)
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2012-10-15</span>
&nbsp;| <span id="projectVersion">Version: 0.16.0</span>
</div>
<div class="xright"> <a href="http://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase#.281.29_What_Is_Incubation.3F" class="externalLink" title="This content is PRELIMINARY API and still subject to change">This content is PRELIMINARY API and still subject to change</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Tycho</h5>
<ul>
<li class="none">
<a href="../index.html" title="Introduction">Introduction</a>
</li>
<li class="none">
<a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin">Compiler Plugin</a>
</li>
<li class="none">
<a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin">Packaging Plugin</a>
</li>
<li class="none">
<a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin">Source Plugin</a>
</li>
<li class="none">
<a href="../tycho-surefire/tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin">Surefire Plugin</a>
</li>
<li class="none">
<a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin">Versions Plugin</a>
</li>
<li class="none">
<a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="P2 Director Plugin">P2 Director Plugin</a>
</li>
<li class="none">
<a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="P2 Repository Plugin">P2 Repository Plugin</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>tycho-packaging:build-qualifier-aggregator<a name="tycho-packaging:build-qualifier-aggregator"></a></h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho:tycho-packaging-plugin:0.16.0:build-qualifier-aggregator</p>
<p><b>Description</b>:</p>
<div>This mojo calculates build timestamp as the latest timestamp of the
project itself and timestamps of bundles and features directly
included in the project. This is meant to work with custom
timestamp providers and generate build qualifier based on build
contents, i.e. the source code, and not the time the build was
started; rebuilding the same source code will result in the same
version qualifier.
<p>Timestamp of included bundles and features is determined by
parsing their respective version qualifiers. Qualifiers that cannot
be parsed are silently ignored, which can result in old version
qualifier used even when aggregator project contents actually
changed. In this case aggregator project timestamp will have to be
increased manually, using artificial SCM commit for example.</p>
<p>Qualifier aggregation is enabled only for projects with custom
timestamp provider, i.e. &lt;timestampProvider&gt; is set in
pom.xlm to a value other than &quot;default&quot;. The default build
timestamp provider uses build start time as build timestamp, which
should be newer or equal than timestamp of any included
bundle/feature project, which makes qualifier aggregation
redundant.</p></div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Binds by default to the lifecycle phase: <tt>validate</tt>.</li>
</ul>
<div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
<table class="bodyTable" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#baseDir">baseDir</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#execution">execution</a></b></td>
<td><tt>MojoExecution</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /></td>
</tr>
<tr class="b">
<td><b><a href="#forceContextQualifier">forceContextQualifier</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /></td>
</tr>
<tr class="a">
<td><b><a href="#format">format</a></b></td>
<td><tt>SimpleDateFormat</tt></td>
<td><tt>-</tt></td>
<td>Specify a date format as specified by java.text.SimpleDateFormat.
Timezone used is UTC.<br /><b>Default value is</b>: <tt>yyyyMMddHHmm</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#timestampProvider">timestampProvider</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Role hint of a custom build timestamp provider.<br /></td>
</tr>
</table>
</div>
<div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
<p><b><a name="baseDir">baseDir</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.basedir}</tt></li>
</ul><hr /><p><b><a name="execution">execution</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>org.apache.maven.plugin.MojoExecution</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${mojoExecution}</tt></li>
</ul><hr /><p><b><a name="forceContextQualifier">forceContextQualifier</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${forceContextQualifier}</tt></li>
</ul><hr /><p><b><a name="format">format</a>:</b></p>
<div>Specify a date format as specified by java.text.SimpleDateFormat.
Timezone used is UTC.</div>
<ul>
<li><b>Type</b>: <tt>java.text.SimpleDateFormat</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>yyyyMMddHHmm</tt></li>
</ul><hr /><p><b><a name="timestampProvider">timestampProvider</a>:</b></p>
<div>Role hint of a custom build timestamp provider.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul>
</div>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright &#169; 2008-2012
<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>