Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 810b166043f1643521de43482f7ab5a368a37868 / . / bundleplugin / doc / site / baseline-mojo.html
blob: 296fb5d4bb78064af8a22d42e0b671d17969ff23 [file] [log] [blame]
Stuart McCulloch87b04322014-06-20 11:21:27 +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<!-- Generated by Apache Maven Doxia at Jun 20, 2014 -->
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <title>Maven Bundle Plugin -
7 bundle:baseline</title>
8 <style type="text/css" media="all">
9 @import url("./css/maven-base.css");
10 @import url("./css/maven-theme.css");
11 @import url("./css/site.css");
12 </style>
13 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
14 <meta name="Date-Revision-yyyymmdd" content="20140620" />
15 <meta http-equiv="Content-Language" content="en" />
16
17 </head>
18 <body class="composite">
19 <div id="banner">
20 <div id="bannerLeft">
21 Maven Bundle Plugin
22 </div>
23 <div class="clear">
24 <hr/>
25 </div>
26 </div>
27 <div id="breadcrumbs">
28
29
30 <div class="xleft">
31 <span id="publishDate">Last Published: 2014-06-20</span>
32 &nbsp;| <span id="projectVersion">Version: 2.5.0</span>
33 </div>
34 <div class="xright">
35
36 </div>
37 <div class="clear">
38 <hr/>
39 </div>
40 </div>
41 <div id="leftColumn">
42 <div id="navcolumn">
43
44
45 <h5>Overview</h5>
46 <ul>
47 <li class="none">
48 <a href="index.html" title="Introduction">Introduction</a>
49 </li>
50 <li class="none">
51 <a href="plugin-info.html" title="Goals">Goals</a>
52 </li>
53 <li class="none">
54 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Maven+Bundle+Plugin+%28BND%29" class="externalLink" title="Wiki">Wiki</a>
55 </li>
56 <li class="none">
57 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Bundle+Plugin+FAQ" class="externalLink" title="FAQ">FAQ</a>
58 </li>
59 <li class="none">
60 <a href="jira-report.html" title="Release Notes">Release Notes</a>
61 </li>
62 </ul>
63 <h5>Project Documentation</h5>
64 <ul>
65 <li class="collapsed">
66 <a href="project-info.html" title="Project Information">Project Information</a>
67 </li>
68 <li class="collapsed">
69 <a href="project-reports.html" title="Project Reports">Project Reports</a>
70 </li>
71 </ul>
72 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
73 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
74 </a>
75
76
77 </div>
78 </div>
79 <div id="bodyColumn">
80 <div id="contentBox">
81
82
83 <div class="section"><h2>bundle:baseline<a name="bundle:baseline"></a></h2>
84 <p><b>Full name</b>:</p>
85 <p>org.apache.felix:maven-bundle-plugin:2.5.0:baseline</p>
86 <p><b>Description</b>:</p>
87 <div>BND Baseline check between two bundles.</div>
88 <p><b>Attributes</b>:</p>
89 <ul>
90 <li>Requires a Maven project to be executed.</li>
91 <li>The goal is thread-safe and supports parallel builds.</li>
92 <li>Since version: <tt>2.4.1</tt>.</li>
93 <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>verify</tt>.</li>
94 </ul>
95 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
96 <table class="bodyTable" border="0">
97 <tr class="a">
98 <th>Name</th>
99 <th>Type</th>
100 <th>Since</th>
101 <th>Description</th>
102 </tr>
103 <tr class="b">
104 <td><b><a href="#failOnError">failOnError</a></b></td>
105 <td><tt>boolean</tt></td>
106 <td><tt>2.4.1</tt></td>
107 <td>Whether to fail on errors.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>baseline.failOnError</tt>.</td>
108 </tr>
109 <tr class="a">
110 <td><b><a href="#failOnWarning">failOnWarning</a></b></td>
111 <td><tt>boolean</tt></td>
112 <td><tt>2.4.1</tt></td>
113 <td>Whether to fail on warnings.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>baseline.failOnWarning</tt>.</td>
114 </tr>
115 <tr class="b">
116 <td><b><a href="#filters">filters</a></b></td>
117 <td><tt>String[]</tt></td>
118 <td><tt>2.4.1</tt></td>
119 <td>A list of packages filter, if empty the whole bundle will be
120traversed. Values are specified in OSGi package instructions
121notation, e.g. <tt>!org.apache.felix.bundleplugin</tt>.<br /></td>
122 </tr>
123 <tr class="a">
124 <td><b><a href="#logResults">logResults</a></b></td>
125 <td><tt>boolean</tt></td>
126 <td><tt>2.4.1</tt></td>
127 <td>Whether to log the results to the console or not, true by default.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>logResults</tt>.</td>
128 </tr>
129 <tr class="b">
130 <td><b><a href="#skip">skip</a></b></td>
131 <td><tt>boolean</tt></td>
132 <td><tt>2.4.1</tt></td>
133 <td>Flag to easily skip execution.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>baseline.skip</tt>.</td>
134 </tr>
135 <tr class="a">
136 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
137 <td><tt>List</tt></td>
138 <td><tt>2.4.1</tt></td>
139 <td>Project types which this plugin supports.<br /></td>
140 </tr>
141 <tr class="b">
142 <td><b><a href="#xmlOutputFile">xmlOutputFile</a></b></td>
143 <td><tt>File</tt></td>
144 <td><tt>2.4.1</tt></td>
145 <td>An XML output file to render to
146<tt>${project.build.directory}/baseline.xml</tt>.<br /></td>
147 </tr>
148 </table>
149 </div>
150 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
151 <p><b><a name="failOnError">failOnError</a>:</b></p>
152 <div>Whether to fail on errors.</div>
153 <ul>
154 <li><b>Type</b>: <tt>boolean</tt></li>
155 <li><b>Since</b>: <tt>2.4.1</tt></li>
156 <li><b>Required</b>: <tt>No</tt></li>
157 <li><b>User Property</b>: <tt>baseline.failOnError</tt></li>
158 <li><b>Default</b>: <tt>true</tt></li>
159 </ul><hr /><p><b><a name="failOnWarning">failOnWarning</a>:</b></p>
160 <div>Whether to fail on warnings.</div>
161 <ul>
162 <li><b>Type</b>: <tt>boolean</tt></li>
163 <li><b>Since</b>: <tt>2.4.1</tt></li>
164 <li><b>Required</b>: <tt>No</tt></li>
165 <li><b>User Property</b>: <tt>baseline.failOnWarning</tt></li>
166 <li><b>Default</b>: <tt>false</tt></li>
167 </ul><hr /><p><b><a name="filters">filters</a>:</b></p>
168 <div>A list of packages filter, if empty the whole bundle will be
169traversed. Values are specified in OSGi package instructions
170notation, e.g. <tt>!org.apache.felix.bundleplugin</tt>.</div>
171 <ul>
172 <li><b>Type</b>: <tt>java.lang.String[]</tt></li>
173 <li><b>Since</b>: <tt>2.4.1</tt></li>
174 <li><b>Required</b>: <tt>No</tt></li>
175 </ul><hr /><p><b><a name="logResults">logResults</a>:</b></p>
176 <div>Whether to log the results to the console or not, true by default.</div>
177 <ul>
178 <li><b>Type</b>: <tt>boolean</tt></li>
179 <li><b>Since</b>: <tt>2.4.1</tt></li>
180 <li><b>Required</b>: <tt>No</tt></li>
181 <li><b>User Property</b>: <tt>logResults</tt></li>
182 <li><b>Default</b>: <tt>true</tt></li>
183 </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
184 <div>Flag to easily skip execution.</div>
185 <ul>
186 <li><b>Type</b>: <tt>boolean</tt></li>
187 <li><b>Since</b>: <tt>2.4.1</tt></li>
188 <li><b>Required</b>: <tt>No</tt></li>
189 <li><b>User Property</b>: <tt>baseline.skip</tt></li>
190 <li><b>Default</b>: <tt>false</tt></li>
191 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
192 <div>Project types which this plugin supports.</div>
193 <ul>
194 <li><b>Type</b>: <tt>java.util.List</tt></li>
195 <li><b>Since</b>: <tt>2.4.1</tt></li>
196 <li><b>Required</b>: <tt>No</tt></li>
197 </ul><hr /><p><b><a name="xmlOutputFile">xmlOutputFile</a>:</b></p>
198 <div>An XML output file to render to
199<tt>${project.build.directory}/baseline.xml</tt>.</div>
200 <ul>
201 <li><b>Type</b>: <tt>java.io.File</tt></li>
202 <li><b>Since</b>: <tt>2.4.1</tt></li>
203 <li><b>Required</b>: <tt>No</tt></li>
204 <li><b>Expression</b>: <tt>${project.build.directory}/baseline.xml</tt></li>
205 </ul>
206 </div>
207 </div>
208
209
210 </div>
211 </div>
212 <div class="clear">
213 <hr/>
214 </div>
215 <div id="footer">
216 <div class="xright">Copyright &#169; 2006-2014
217 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
218 All Rights Reserved.
219
220 </div>
221 <div class="clear">
222 <hr/>
223 </div>
224 </div>
225 </body>
226</html>