| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-09-04 --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| <title>Apache Rat™ Plugin for Apache Maven – Frequently Asked Questions</title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta name="Date-Revision-yyyymmdd" content="20160904" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Mate+SC" type="text/css"/> |
| |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="https://www.apache.org/" id="bannerLeft"> |
| <img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" title="The Apache Software Foundation" /> |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2016-09-04</span> |
| | <span id="projectVersion">Version: 0.13-SNAPSHOT</span> |
| | <a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a> |
| > |
| <a href="https://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> |
| > |
| <a href="https://creadur.apache.org/rat/" class="externalLink" title="Rat">Rat</a> |
| > |
| <a href="./" title="Apache Rat™ Plugin for Apache Maven">Apache Rat™ Plugin for Apache Maven</a> |
| > |
| Frequently Asked Questions |
| </div> |
| <div class="xright"> |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| <h5>Parent Project</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Apache Creadur Rat">Apache Creadur Rat</a> |
| </li> |
| </ul> |
| <h5>Overview</h5> |
| <ul> |
| <li class="none"> |
| <a href="index.html" title="Introduction">Introduction</a> |
| </li> |
| <li class="none"> |
| <a href="plugin-info.html" title="Goals">Goals</a> |
| </li> |
| <li class="none"> |
| <a href="usage.html" title="Usage">Usage</a> |
| </li> |
| <li class="none"> |
| <strong>FAQ</strong> |
| </li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| <li class="none"> |
| <a href="examples/basic.html" title="Basic use">Basic use</a> |
| </li> |
| <li class="none"> |
| <a href="examples/verify.html" title="Running the plugin automatically">Running the plugin automatically</a> |
| </li> |
| <li class="none"> |
| <a href="examples/site.html" title="Adding a report to the site">Adding a report to the site</a> |
| </li> |
| <li class="none"> |
| <a href="examples/custom-license.html" title="Custom license">Custom license</a> |
| </li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| <li class="collapsed"> |
| <a href="project-info.html" title="Project Information">Project Information</a> |
| </li> |
| <li class="collapsed"> |
| <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| </li> |
| </ul> |
| <h5>Apache Rat™</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Introducing Rat">Introducing Rat</a> |
| </li> |
| <li class="none"> |
| <a href="../apidocs/index.html" title="Javadocs">Javadocs</a> |
| </li> |
| <li class="none"> |
| <a href="../download_rat.cgi" title="Downloads">Downloads</a> |
| </li> |
| <li class="none"> |
| <a href="../RELEASE_NOTES.txt" title="Changes">Changes</a> |
| </li> |
| </ul> |
| <h5>Running Rat</h5> |
| <ul> |
| <li class="none"> |
| <a href="../apache-rat/index.html" title="From The Command Line">From The Command Line</a> |
| </li> |
| <li class="none"> |
| <a href="../apache-rat-tasks/index.html" title="With Ant">With Ant</a> |
| </li> |
| <li class="none"> |
| <a href="../apache-rat-plugin/index.html" title="With Maven">With Maven</a> |
| </li> |
| </ul> |
| <h5>Apache Creadur™</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://creadur.apache.org" class="externalLink" title="Creadur Project Home">Creadur Project Home</a> |
| </li> |
| <li class="none"> |
| <a href="https://creadur.apache.org/tentacles" class="externalLink" title="Apache Tentacles">Apache Tentacles</a> |
| </li> |
| <li class="none"> |
| <a href="https://creadur.apache.org/whisker" class="externalLink" title="Apache Whisker">Apache Whisker</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/security/" class="externalLink" title="Security">Security</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/licenses/" class="externalLink" title="License">License</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a> |
| </li> |
| </ul> |
| <h5>The Apache Software Foundation</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation" class="externalLink" title="About the Foundation">About the Foundation</a> |
| </li> |
| <li class="none"> |
| <a href="https://projects.apache.org" class="externalLink" title="The projects">The projects</a> |
| </li> |
| <li class="none"> |
| <a href="https://people.apache.org" class="externalLink" title="The people">The people</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How we work">How we work</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/how-it-works.html#history" class="externalLink" title="Our history">Our history</a> |
| </li> |
| <li class="none"> |
| <a href="https://blogs.apache.org/foundation/" class="externalLink" title="News">News</a> |
| </li> |
| </ul> |
| <h5>Contribute</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">Get Involved</a> |
| </li> |
| </ul> |
| <h5>Committer Info</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://www.apache.org/dev/committers.html" class="externalLink" title="ASF Committers' FAQ">ASF Committers' FAQ</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/dev/new-committers-guide.html" class="externalLink" title="New Committers Guide">New Committers Guide</a> |
| </li> |
| <li class="none"> |
| <a href="../site-publish.html" title="Howto publish this site">Howto publish this site</a> |
| </li> |
| <li class="none"> |
| <a href="https://planet.apache.org/committers/" class="externalLink" title="Plant Apache">Plant Apache</a> |
| </li> |
| <li class="none"> |
| <a href="https://community.apache.org/" class="externalLink" title="Community">Community</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/legal/" class="externalLink" title="Legal">Legal</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/marks/" class="externalLink" title="Branding">Branding</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/press/" class="externalLink" title="Media Relations">Media Relations</a> |
| </li> |
| </ul> |
| <a href="https://maven.apache.org/" title="Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> |
| </a> |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| <!-- 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. --><div class="section"> |
| <h2><a name="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#what">What is Rat?</a></li> |
| <li><a href="#where">Where do I find Apache Rat?</a></li> |
| <li><a href="#why">Why should I use the Maven plugin to run Apache Rat?</a></li></ol> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#includeSubprojects"> |
| The apache-rat-plugin creates a report for every subproject. |
| I want a single report for the whole project, which includes |
| the subprojects. |
| </a></li> |
| <li><a href="#customLicense">Can I use Rat to validate against a custom license header?</a></li></ol></div> |
| <dl> |
| <dt><a name="what">What is Rat?</a></dt> |
| <dd> |
| |
| <p> |
| Basically, you can think of it as a tool that checks, |
| whether you're source files are carrying proper |
| license headers. Almost any non-trivial organization |
| has a policy for license headers. In the case |
| of the <a class="externalLink" href="http://www.apache.org/">Apache Software |
| Foundation (ASF)</a>, this is the |
| <a class="externalLink" href="http://www.apache.org/legal/src-headers.html">ASF |
| Source Header and Copyright Notice Policy</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="where">Where do I find Apache Rat?</a></dt> |
| <dd> |
| |
| <p> |
| Apache Rat is now part of the |
| <a class="externalLink" href="http://creadur.apache.org">Apache Creadur</a> project, |
| a home for all sorts of software that helps audit and review |
| software distributions. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="why">Why should I use the Maven plugin to run Apache Rat?</a></dt> |
| <dd> |
| |
| <p>Because it makes running Rat trivial. Basically, you just |
| add the plugin to the <tt>build/plugins</tt> section |
| of your POM and run <tt>mvn apache-rat:check</tt>. Using Rat |
| cannot be simpler. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl> |
| <dl> |
| <dt><a name="includeSubprojects"> |
| The apache-rat-plugin creates a report for every subproject. |
| I want a single report for the whole project, which includes |
| the subprojects. |
| </a></dt> |
| <dd> |
| |
| <p>Set the configuration parameter "excludeSubProjects" |
| to false.</p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="customLicense">Can I use Rat to validate against a custom license header?</a></dt> |
| <dd> |
| |
| <p>See <a href="examples/custom-license.html">this example</a> to see how.</p> |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <footer>Copyright © 2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather logo are trademarks |
| of The Apache Software Foundation. |
| Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners.</footer> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
