Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 9ea5e0e8b6e127a9a6503c16d0512d0462c09f88 / . / bundleplugin / doc / site / index.html
blob: 4262a803711831f362526c23f0deea3d6857f7c4 [file] [log] [blame]
Stuart McCulloch55213332011-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">
2
3<!-- Generated by Apache Maven Doxia at Jul 5, 2011 -->
4
5<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
7 <head>
8
9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
10
11 <title>Maven Bundle Plugin - Introduction</title>
12
13 <style type="text/css" media="all">
14
15 @import url("./css/maven-base.css");
16
17 @import url("./css/maven-theme.css");
18
19 @import url("./css/site.css");
20
21 </style>
22
23 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
24
25 <meta name="author" content="Stuart McCulloch" />
26
27 <meta name="Date-Creation-yyyymmdd" content="20110628" />
28
29 <meta name="Date-Revision-yyyymmdd" content="20110705" />
30
31 <meta http-equiv="Content-Language" content="en" />
32
33
34
35 </head>
36
37 <body class="composite">
38
39 <div id="banner">
40
41 <div id="bannerLeft">
42
43 Maven Bundle Plugin
44
45 </div>
46
47 <div class="clear">
48
49 <hr/>
50
51 </div>
52
53 </div>
54
55 <div id="breadcrumbs">
56
57
58
59
60
61 <div class="xleft">
62
63 <span id="publishDate">Last Published: 2011-07-05</span>
64
65 &nbsp;| <span id="projectVersion">Version: 2.3.5</span>
66
67 </div>
68
69 <div class="xright">
70
71
72
73 </div>
74
75 <div class="clear">
76
77 <hr/>
78
79 </div>
80
81 </div>
82
83 <div id="leftColumn">
84
85 <div id="navcolumn">
86
87
88
89
90
91 <h5>Overview</h5>
92
93 <ul>
94
95 <li class="none">
96
97 <strong>Introduction</strong>
98
99 </li>
100
101 <li class="none">
102
103 <a href="plugin-info.html" title="Goals">Goals</a>
104
105 </li>
106
107 <li class="none">
108
109 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Maven+Bundle+Plugin+%28BND%29" class="externalLink" title="Wiki">Wiki</a>
110
111 </li>
112
113 <li class="none">
114
115 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Bundle+Plugin+FAQ" class="externalLink" title="FAQ">FAQ</a>
116
117 </li>
118
119 <li class="none">
120
121 <a href="jira-report.html" title="Release Notes">Release Notes</a>
122
123 </li>
124
125 </ul>
126
127 <h5>Project Documentation</h5>
128
129 <ul>
130
131 <li class="expanded">
132
133 <a href="project-info.html" title="Project Information">Project Information</a>
134
135 <ul>
136
137 <li class="none">
138
139 <strong>About</strong>
140
141 </li>
142
143 <li class="none">
144
145 <a href="dependencies.html" title="Dependencies">Dependencies</a>
146
147 </li>
148
149 <li class="none">
150
151 <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
152
153 </li>
154
155 <li class="none">
156
157 <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
158
159 </li>
160
161 <li class="none">
162
163 <a href="license.html" title="Project License">Project License</a>
164
165 </li>
166
167 <li class="none">
168
169 <a href="team-list.html" title="Project Team">Project Team</a>
170
171 </li>
172
173 <li class="none">
174
175 <a href="source-repository.html" title="Source Repository">Source Repository</a>
176
177 </li>
178
179 </ul>
180
181 </li>
182
183 <li class="collapsed">
184
185 <a href="project-reports.html" title="Project Reports">Project Reports</a>
186
187 </li>
188
189 </ul>
190
191 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
192
193 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
194
195 </a>
196
197
198
199
200
201 </div>
202
203 </div>
204
205 <div id="bodyColumn">
206
207 <div id="contentBox">
208
209 <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt-format.html --><div class="section"><h2>Maven Bundle Plugin<a name="Maven_Bundle_Plugin"></a></h2><p>This Maven 2 plugin is based on the <a class="externalLink" href="http://www.aqute.biz/Bnd/Bnd/">BND</a> tool from Peter Kriens. The way BND works is by treating your project as a big collection of classes (e.g., project code, dependencies, and the class path). The way you create a bundle with BND is to tell it the content of the bundle's JAR file as a subset of the available classes. This plugin wraps BND to make it work specifically with the Maven 2 project structure and to provide it with reasonable default behavior for Maven 2 projects.</p><div class="section"><h3>Goals Overview<a name="Goals_Overview"></a></h3><p>General Information about the goals.</p><ul><li><a href="./bundle-mojo.html">bundle:bundle</a> Create an OSGi bundle from Maven project. (life-cycle goal)</li><li><a href="./manifest-mojo.html">bundle:manifest</a> Generate an OSGi manifest for this project.</li><li><a href="./cleanVersions-mojo.html">bundle:cleanVersions</a> Convert a group of versions to OSGi format.</li><li><a href="./instructions-mojo.html">bundle:instructions</a> Generate BND instructions for this project.</li><li><a href="./install-mojo.html">bundle:install</a> Installs bundle details in the local OBR repository. (life-cycle goal)</li><li><a href="./deploy-mojo.html">bundle:deploy</a> Deploys bundle details to a remote OBR repository. (life-cycle goal)</li><li><a href="./index-mojo.html">bundle:index</a> Index the content of a maven repository using OBR.</li><li><a href="./install-file-mojo.html">bundle:install-file</a> Installs bundle details in the local OBR repository. (command-line goal)</li><li><a href="./deploy-file-mojo.html">bundle:deploy-file</a> Deploys bundle details to a remote OBR repository. (command-line goal)</li><li><a href="./clean-mojo.html">bundle:clean</a> Clean a local OBR repository by finding and removing missing resources.</li><li><a href="./remote-clean-mojo.html">bundle:remote-clean</a> Clean a remote OBR repository by finding and removing missing resources.</li><li><a href="./ant-mojo.html">bundle:ant</a> Generate Ant script to create the bundle. (you should run ant:ant first)</li></ul></div><div class="section"><h3>Usage<a name="Usage"></a></h3><p>General instructions on how to use the Maven Bundle Plugin can be found on the <a class="externalLink" href="http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html">wiki page</a>. Some more specific use cases are described in the examples given below.</p><p>In case you still have questions regarding the plugin's usage, please have a look at the <a class="externalLink" href="http://felix.apache.org/site/apache-felix-bundle-plugin-faq.html">FAQ</a> and feel free to contact the <a class="externalLink" href="http://felix.apache.org/site/mailinglists.html">user mailing list</a>. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the <a class="externalLink" href="http://www.mail-archive.com/users@felix.apache.org/">mail archive</a>.</p><p>If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our <a href="./issue-tracking.html">issue tracker</a>. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our <a href="./source-repository.html">source repository</a> and will find supplementary information in the <a class="externalLink" href="http://felix.apache.org/site/development.html">Apache Felix developers guide</a>. </p></div><div class="section"><h3>Examples<a name="Examples"></a></h3><p>To provide you with better understanding on some usages of the Maven Bundle Plugin, you can take a look into the following examples:</p><ul><li>Examples coming soon!</li></ul></div></div>
210
211 </div>
212
213 </div>
214
215 <div class="clear">
216
217 <hr/>
218
219 </div>
220
221 <div id="footer">
222
223 <div class="xright">Copyright &#169; 2006-2011
224
225 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
226
227 All Rights Reserved.
228
229
230
231 </div>
232
233 <div class="clear">
234
235 <hr/>
236
237 </div>
238
239 </div>
240
241 </body>
242
243</html>
244