Debian Codegraph @

animal-sniffer-maven-plugin/src/site/fml/faq.fml

raw
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 The MIT License
4
5 Copyright (c) 2009 codehaus.org.
6
7 Permission is hereby granted, free of charge, to any person obtaining a copy
8 of this software and associated documentation files (the "Software"), to deal
9 in the Software without restriction, including without limitation the rights
10 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 copies of the Software, and to permit persons to whom the Software is
12 furnished to do so, subject to the following conditions:
13
14 The above copyright notice and this permission notice shall be included in
15 all copies or substantial portions of the Software.
16
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 THE SOFTWARE.
24 -->
25 <faqs id="FAQ" title="Frequently Asked Questions">
26 <part id="general">
27 <title>General</title>
28
29 <faq id="purpose">
30 <question>What does the Animal Sniffer Maven Plugin do?</question>
31 <answer>
32 <p>The Animal Sniffer Maven Plugin provides a means to verify that your classes only use the classes, methods and fields provided by specific API signatures that you specify. The plugin also provides a means to generate API signatures from your project and/or a specific JDK.</p>
33 </answer>
34 </faq>
35
36 <faq id="name">
37 <question>Why the name?
38 </question>
39 <answer>
40 <p>
41 The plugin's original author (Kohsuke Kawaguchi) named the plugin
42 animal-sniffer because it was originally designed to detect which
43 version of a JRE had been used to compile your classes. As such it was
44 detecting the "scent" of each JRE.
45 </p>
46 <p>
47 Sun has traditionally named each of the major versions of its JRE after
48 different animals. For example 1.5 (a.k.a Java SE 5.0) was known as
49 Tiger; 1.6 (a.k.a. Java SE 6.0) was known as Mustang. Since this plugin
50 detects the "scent" of each of these "animals" it got the name
51 "animal-sniffer".
52 </p>
53 </answer>
54 </faq>
55 <faq id="java.net">
56 <question>Which is the "official" animal-sniffer host: Codehaus or java.net?</question>
57 <answer>
58 <p>
59 This project is the "official" project. The
60 <a href="https://animal-sniffer.dev.java.net">java.net</a> project
61 was started by Kohsuke Kawaguchi before he was granted commit access
62 to the mojo project. Since Kohsuke was granted commit access in part
63 to allow the migration of animal-sniffer to Codehaus, he has decreed
64 the Codehaus version the "official" version as well as re-licensed
65 the Codehaus version under the MIT License. The java.net version
66 remains licensed under CDDL.
67 </p>
68 <p>
69 This version (by virtue of belonging to mojo.codehaus.org) has the
70 advantage of being available in the
71 <a href="http://repo1.maven.org">Maven Central repository</a>
72 which means that projects which publish to the Maven Central
73 repository can use this version in their <code>pom.xml</code>.
74 <strong>Note:</strong> Projects which publish to the Maven Central repository must
75 only reference dependencies and plugins available from the
76 Maven Central repository and may not reference other repositories.
77 </p>
78 <p>
79 In addition, this version has been subject to on-going development
80 effort.
81 </p>
82 </answer>
83 </faq>
84 </part>
85 </faqs>