| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/generate-poms-mojo.xml at 2020-08-03 |
| | Rendered using Apache Maven Fluido Skin 1.9 |
| --> |
| <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.2" /> |
| <title>Tycho POM Generator Plugin – tycho-pomgenerator:generate-poms</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.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.9.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h2>Tycho POM Generator 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-08-03<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.0.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-pomgenerator:generate-poms"></a>tycho-pomgenerator:generate-poms</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.tycho:tycho-pomgenerator-plugin:2.0.0:generate-poms</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Traverse the current directory to find eclipse-plugin/bundle, |
| feature, update site (site.xml) or p2 repository (category.xml) |
| projects and generate corresponding pom.xml's. This goal is |
| intended to be used by existing projects for generating quick-start |
| pom.xml's when converting their build to Tycho. The generated |
| pom.xml's are only intended as a starting point and will most |
| probably require manual refinement. Note that this goal is not |
| intended for automatic pom.xml generation during build.</div> |
| |
| <p><b>Attributes</b>:</p> |
| <section> |
| <h3><a name="Required_Parameters"></a>Required 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><code><a href="#baseDir"><baseDir></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>The base directory which will be traversed recursively when |
| searching for projects.<br /><b>Default value is</b>: <code>${basedir}</code>.<br /><b>User property is</b>: <code>baseDir</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <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><code><a href="#aggregator"><aggregator></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>If true (the default), additional aggregator poma.xml pom file will |
| be generated for update site projects. This poma.xml file can be |
| used to build update site and all its dependencies.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>aggregator</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#executionEnvironment"><executionEnvironment></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <code>J2SE-1.5</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#extraDirs"><extraDirs></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Additional directories to be traversed recursively when searching |
| for projects.<br /><b>User property is</b>: <code>extraDirs</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#groupId"><groupId></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Maven groupId to be used in the generated pom.xml files.<br /><b>User property is</b>: <code>groupId</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#repoID"><repoID></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>ID of the p2 repository to add in the aggregator pom.<br /><b>Default value is</b>: <code>injected-repository</code>.<br /><b>User property is</b>: <code>repoID</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#repoURL"><repoURL></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>URL to p2 repository to add in the aggregator pom.<br /><b>User property is</b>: <code>repoURL</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#rootProjects"><rootProjects></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Comma separated list of root project folders. If specified, |
| generated pom.xml files will only include root projects and |
| projects directly and indirectly referenced by the root projects.<br /><b>User property is</b>: <code>rootProjects</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#templatesDir"><templatesDir></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Location of directory with template pom.xml file. pom.xml templates |
| will be looked at this directory first, default templates will be |
| used if template directory and the template itself does not exist. |
| See src/main/resources/templates for the list of supported template |
| files.<br /><b>Default value is</b>: <code>${basedir}/pom-templates</code>.<br /><b>User property is</b>: <code>templatesDir</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#testSuffix"><testSuffix></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Suffix used to determine test bundles to add to update site |
| aggregator pom.<br /><b>Default value is</b>: <code>.tests</code>.<br /><b>User property is</b>: <code>testSuffix</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#testSuite"><testSuite></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Bundle-SymbolicName of the test suite, a special bundle that knows |
| how to locate and execute all relevant tests.<br /><b>User property is</b>: <code>testSuite</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#version"><version></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Maven version to be used in the generated pom.xml files (applies to |
| parent pom and eclipse-repository/eclipse-update-site only).<br /><b>Default value is</b>: <code>0.0.1-SNAPSHOT</code>.<br /><b>User property is</b>: <code>version</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3Caggregator.3E"></a><b><a name="aggregator"><aggregator></a></b></h4> |
| |
| <div>If true (the default), additional aggregator poma.xml pom file will |
| be generated for update site projects. This poma.xml file can be |
| used to build update site and all its dependencies.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>aggregator</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CbaseDir.3E"></a><b><a name="baseDir"><baseDir></a></b></h4> |
| |
| <div>The base directory which will be traversed recursively when |
| searching for projects.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>Yes</code></li> |
| |
| <li><b>User Property</b>: <code>baseDir</code></li> |
| |
| <li><b>Default</b>: <code>${basedir}</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CexecutionEnvironment.3E"></a><b><a name="executionEnvironment"><executionEnvironment></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>J2SE-1.5</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CextraDirs.3E"></a><b><a name="extraDirs"><extraDirs></a></b></h4> |
| |
| <div>Additional directories to be traversed recursively when searching |
| for projects.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>extraDirs</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CgroupId.3E"></a><b><a name="groupId"><groupId></a></b></h4> |
| |
| <div>Maven groupId to be used in the generated pom.xml files.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>groupId</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CrepoID.3E"></a><b><a name="repoID"><repoID></a></b></h4> |
| |
| <div>ID of the p2 repository to add in the aggregator pom.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>repoID</code></li> |
| |
| <li><b>Default</b>: <code>injected-repository</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CrepoURL.3E"></a><b><a name="repoURL"><repoURL></a></b></h4> |
| |
| <div>URL to p2 repository to add in the aggregator pom.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>repoURL</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CrootProjects.3E"></a><b><a name="rootProjects"><rootProjects></a></b></h4> |
| |
| <div>Comma separated list of root project folders. If specified, |
| generated pom.xml files will only include root projects and |
| projects directly and indirectly referenced by the root projects.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>rootProjects</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtemplatesDir.3E"></a><b><a name="templatesDir"><templatesDir></a></b></h4> |
| |
| <div>Location of directory with template pom.xml file. pom.xml templates |
| will be looked at this directory first, default templates will be |
| used if template directory and the template itself does not exist. |
| See src/main/resources/templates for the list of supported template |
| files.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>templatesDir</code></li> |
| |
| <li><b>Default</b>: <code>${basedir}/pom-templates</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtestSuffix.3E"></a><b><a name="testSuffix"><testSuffix></a></b></h4> |
| |
| <div>Suffix used to determine test bundles to add to update site |
| aggregator pom.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>testSuffix</code></li> |
| |
| <li><b>Default</b>: <code>.tests</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtestSuite.3E"></a><b><a name="testSuite"><testSuite></a></b></h4> |
| |
| <div>Bundle-SymbolicName of the test suite, a special bundle that knows |
| how to locate and execute all relevant tests.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>testSuite</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cversion.3E"></a><b><a name="version"><version></a></b></h4> |
| |
| <div>Maven version to be used in the generated pom.xml files (applies to |
| parent pom and eclipse-repository/eclipse-update-site only).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>version</code></li> |
| |
| <li><b>Default</b>: <code>0.0.1-SNAPSHOT</code></li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2008–2020 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
