Debian Codegraph @

animal-sniffer-enforcer-rule/src/site/apt/index.apt.vm

raw
1 ~~ The MIT License
2 ~~
3 ~~ Copyright (c) 2009 codehaus.org.
4 ~~
5 ~~ Permission is hereby granted, free of charge, to any person obtaining a copy
6 ~~ of this software and associated documentation files (the "Software"), to deal
7 ~~ in the Software without restriction, including without limitation the rights
8 ~~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ~~ copies of the Software, and to permit persons to whom the Software is
10 ~~ furnished to do so, subject to the following conditions:
11 ~~
12 ~~ The above copyright notice and this permission notice shall be included in
13 ~~ all copies or substantial portions of the Software.
14 ~~
15 ~~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 ~~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 ~~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 ~~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 ~~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 ~~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 ~~ THE SOFTWARE.
22 ~~
23
24 -----
25 Animal Sniffer Enforcer Rule
26 -----
27 Stephen Connolly
28 -----
29 2009-11-04
30 -----
31
32 Animal Sniffer Enforcer Rule
33
34 The Animal Sniffer Enforcer Rule is used to check your classes against previously generated signatures.
35 This enforcer rule is called animal sniffer because the principal signatures that are used are those of
36 the Java Runtime, and since Sun traditionally names the different versions of its Java Runtimes after
37 different animals, the original project from which this enforcer rule was developed was called "Animal Sniffer".
38
39 * Rules Overview
40
41 The Animal Sniffer Enforcer Rule has the following rule.
42
43 * <<<checkSignatureRule>>> checks a project against an API signature.
44
45 * Usage
46
47 General instructions on how to use the Animal Sniffer Enforcer Rule can be found on the {{{./usage.html}usage page}}.
48 Some more specific use cases are described in the examples given below. Last but not least, users occasionally
49 contribute additional examples, tips or errata to the
50 {{{http://docs.codehaus.org/display/MAVENUSER/Animal+Sniffer+Enforcer+Rule}enforcer rule's wiki page}}.
51
52 In case you still have questions regarding the enforcer rule's usage, feel free to contact the
53 {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
54 already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
55 the {{{./mail-lists.html}mail archive}}.
56
57 If you feel like the enforcer rule is missing a feature or has a defect, you can fill a feature request or bug report
58 in our {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description
59 of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this
60 reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much
61 appreciated. Of course, patches are welcome, too. Contributors can check out the project from our
62 {{{./source-repository.html}source repository}} and will find supplementary information in the
63 {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
64
65 * Examples
66
67 To provide you with better understanding of some usages of Animal Sniffer Enforcer Rule,
68 you can take a look into the following examples:
69
70 * {{{./examples/checking-signatures.html}Checking a project against API signatures}}
71
72 []