Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 87b043248d84c5befd342063d618ecd5a17d7c88 / . / bundleplugin / doc / site / plugin-info.html
blob: 40976016bdb8af657541dae77a1787c23356017b [file] [log] [blame]
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]2<!-- Generated by Apache Maven Doxia at Jun 20, 2014 -->
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]4 <head>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]6 <title>Maven Bundle Plugin - Plugin Documentation</title>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]7 <style type="text/css" media="all">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]8 @import url("./css/maven-base.css");
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]9 @import url("./css/maven-theme.css");
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]10 @import url("./css/site.css");
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]11 </style>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]12 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]13 <meta name="Date-Revision-yyyymmdd" content="20140620" />
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]14 <meta http-equiv="Content-Language" content="en" />
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]15
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]16 </head>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]17 <body class="composite">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]18 <div id="banner">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]19 <div id="bannerLeft">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]20 Maven Bundle Plugin
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]21 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]22 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]23 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]24 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]25 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]26 <div id="breadcrumbs">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]27
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]28
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]29 <div class="xleft">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]30 <span id="publishDate">Last Published: 2014-06-20</span>
31 &nbsp;| <span id="projectVersion">Version: 2.5.0</span>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]32 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]33 <div class="xright">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]34
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]35 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]36 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]37 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]38 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]39 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]40 <div id="leftColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]41 <div id="navcolumn">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]42
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]43
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]44 <h5>Overview</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]45 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]46 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]47 <a href="index.html" title="Introduction">Introduction</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]48 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]49 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]50 <strong>Goals</strong>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]51 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]52 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]53 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Maven+Bundle+Plugin+%28BND%29" class="externalLink" title="Wiki">Wiki</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]54 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]55 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]56 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Bundle+Plugin+FAQ" class="externalLink" title="FAQ">FAQ</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]57 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]58 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]59 <a href="jira-report.html" title="Release Notes">Release Notes</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]60 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]61 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]62 <h5>Project Documentation</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]63 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]64 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]65 <a href="project-info.html" title="Project Information">Project Information</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]66 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]67 <li class="expanded">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]68 <a href="project-reports.html" title="Project Reports">Project Reports</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]69 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]70 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]71 <a href="jira-report.html" title="JIRA Report">JIRA Report</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]72 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]73 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]74 <strong>Plugin Documentation</strong>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]75 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]76 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]77 <a href="xref/index.html" title="Source Xref">Source Xref</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]78 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]79 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]80 <a href="surefire-report.html" title="Surefire Report">Surefire Report</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]81 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]82 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]83 <a href="xref-test/index.html" title="Test Source Xref">Test Source Xref</a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]84 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]85 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]86 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]87 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]88 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]89 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]90 </a>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]91
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]92
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]93 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]94 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]95 <div id="bodyColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]96 <div id="contentBox">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]97 <div class="section"><h2>Plugin Documentation<a name="Plugin_Documentation"></a></h2><a name="Plugin_Documentation"></a><p>Goals available for this plugin:</p><table border="0" class="bodyTable"><tr class="a"><th>Goal</th><th>Report?</th><th>Description</th></tr><tr class="b"><td><a href="ant-mojo.html">bundle:ant</a></td><td>No</td><td>Generate Ant script to create the bundle (you should run ant:ant
98first).</td></tr><tr class="a"><td><a href="baseline-mojo.html">bundle:baseline</a></td><td>No</td><td>BND Baseline check between two bundles.</td></tr><tr class="b"><td><a href="baseline-report-mojo.html">bundle:baseline-report</a></td><td>Yes</td><td>BND Baseline report.</td></tr><tr class="a"><td><a href="bundle-mojo.html">bundle:bundle</a></td><td>No</td><td>Create an OSGi bundle from Maven project</td></tr><tr class="b"><td><a href="bundleall-mojo.html">bundle:bundleall</a></td><td>No</td><td><strong>Deprecated.</strong> The bundleall goal is no longer supported and may be removed in a
99future release</td></tr><tr class="a"><td><a href="clean-mojo.html">bundle:clean</a></td><td>No</td><td>Clean an OBR repository by finding and removing missing resources.</td></tr><tr class="b"><td><a href="cleanVersions-mojo.html">bundle:cleanVersions</a></td><td>No</td><td>No description.</td></tr><tr class="a"><td><a href="deploy-mojo.html">bundle:deploy</a></td><td>No</td><td>Deploys bundle details to a remote OBR repository (life-cycle goal)</td></tr><tr class="b"><td><a href="deploy-file-mojo.html">bundle:deploy-file</a></td><td>No</td><td>Deploys bundle details to a remote OBR repository (command-line
100goal)</td></tr><tr class="a"><td><a href="index-mojo.html">bundle:index</a></td><td>No</td><td>Index the content of a maven repository using OBR</td></tr><tr class="b"><td><a href="install-mojo.html">bundle:install</a></td><td>No</td><td>Installs bundle details in the local OBR repository (life-cycle
101goal)</td></tr><tr class="a"><td><a href="install-file-mojo.html">bundle:install-file</a></td><td>No</td><td>Installs bundle details in the local OBR repository (command-line
102goal)</td></tr><tr class="b"><td><a href="instructions-mojo.html">bundle:instructions</a></td><td>No</td><td>Generate BND instructions for this project</td></tr><tr class="a"><td><a href="manifest-mojo.html">bundle:manifest</a></td><td>No</td><td>Generate an OSGi manifest for this project</td></tr><tr class="b"><td><a href="remote-clean-mojo.html">bundle:remote-clean</a></td><td>No</td><td>Clean a remote repository file. It just looks for every resources
103and check that pointed file exists.</td></tr><tr class="a"><td><a href="wrap-mojo.html">bundle:wrap</a></td><td>No</td><td><strong>Deprecated.</strong> The wrap goal is no longer supported and may be removed in a future
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]104release</td></tr></table><div class="section"><h3>System Requirements<a name="System_Requirements"></a></h3><a name="System_Requirements"></a><p>The following specifies the minimum requirements to run this Maven plugin:</p><table border="0" class="bodyTable"><tr class="a"><td>Maven</td><td>2.0</td></tr><tr class="b"><td>JDK</td><td>1.5</td></tr><tr class="a"><td>Memory</td><td>No minimum requirement.</td></tr><tr class="b"><td>Disk Space</td><td>No minimum requirement.</td></tr></table></div><div class="section"><h3>Usage<a name="Usage"></a></h3><a name="Usage"></a><p>You should specify the version in your project's plugin configuration:</p><div class="source"><pre>&lt;project&gt;
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]105 ...
106 &lt;build&gt;
107 &lt;!-- To define the plugin version in your parent POM --&gt;
108 &lt;pluginManagement&gt;
109 &lt;plugins&gt;
110 &lt;plugin&gt;
111 &lt;groupId&gt;org.apache.felix&lt;/groupId&gt;
112 &lt;artifactId&gt;maven-bundle-plugin&lt;/artifactId&gt;
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]113 &lt;version&gt;2.5.0&lt;/version&gt;
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]114 &lt;/plugin&gt;
115 ...
116 &lt;/plugins&gt;
117 &lt;/pluginManagement&gt;
118 &lt;!-- To use the plugin goals in your POM or parent POM --&gt;
119 &lt;plugins&gt;
120 &lt;plugin&gt;
121 &lt;groupId&gt;org.apache.felix&lt;/groupId&gt;
122 &lt;artifactId&gt;maven-bundle-plugin&lt;/artifactId&gt;
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]123 &lt;version&gt;2.5.0&lt;/version&gt;
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]124 &lt;/plugin&gt;
125 ...
126 &lt;/plugins&gt;
127 &lt;/build&gt;
128 ...
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]129 &lt;!-- To use the report goals in your POM or parent POM --&gt;
130 &lt;reporting&gt;
131 &lt;plugins&gt;
132 &lt;plugin&gt;
133 &lt;groupId&gt;org.apache.felix&lt;/groupId&gt;
134 &lt;artifactId&gt;maven-bundle-plugin&lt;/artifactId&gt;
135 &lt;version&gt;2.5.0&lt;/version&gt;
136 &lt;/plugin&gt;
137 ...
138 &lt;/plugins&gt;
139 &lt;/reporting&gt;
140 ...
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]141&lt;/project&gt;
142</pre></div><p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">&quot;Guide to Configuring Plug-ins&quot;</a></p></div></div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]143 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]144 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]145 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]146 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]147 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]148 <div id="footer">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]149 <div class="xright">Copyright &#169; 2006-2014
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]150 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]151 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]152
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]153 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]154 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]155 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]156 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]157 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]158 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]159</html>