svn commit: r1148218 - /incubator/rat/main/trunk/apache-rat-tasks/src/site/apt/report.apt

[bo...@apache.org]

Author: bodewig
Date: Tue Jul 19 08:09:45 2011
New Revision: 1148218

URL: http://svn.apache.org/viewvc?rev=1148218&view=rev
Log:
what is a license matcher anyway?

Modified:
    incubator/rat/main/trunk/apache-rat-tasks/src/site/apt/report.apt

Modified: incubator/rat/main/trunk/apache-rat-tasks/src/site/apt/report.apt
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-tasks/src/site/apt/report.apt?rev=1148218&r1=1148217&r2=1148218&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-tasks/src/site/apt/report.apt (original)
+++ incubator/rat/main/trunk/apache-rat-tasks/src/site/apt/report.apt Tue Jul 19 08:09:45 2011
@@ -29,7 +29,7 @@ Report Task
   Reports can be RAT's internal XML or plain text format or be styled
   by a custon XSLT stylesheet.
 
-  It is possible to define custom matchers for licenses not supported
+  It is possible to define custom matchers for licenses not directly supported
   by RAT via nested elements to the Report task.
 
 Attributes of the Task
@@ -92,10 +92,30 @@ Nested Elements
 
   Any defined Ant type that implements the <<<IHeaderMatcher>>>
   interface can be used as nested element to provide a matcher to RAT.
+  License matchers are the pieces that make RAT identify the license
+  of a document.
 
   The Ant library already contains types for the built-in license
   matchers but you can define your own classes for custom matchers.
 
+  There are two scenarios where you'd use a nested element to define
+  license matchers to RAT.  The more common one would be if you wanted
+  RAT to detect and identify a license that isn't supported out of the
+  box - in this case you will want to write a custom matcher.
+
+  The second case would be if you want to only detect a subset of
+  licenses known to RAT for some reason.  For example if the only
+  license you want to detect was the Apache License 2.0 you'd first
+  disable the built-in matchers by setting
+  <<<addDefaultLicenseMatchers>>> to false and then explicitly add the
+  built-in <<<asl20>>> matcher
+
+--- 
+<rat:report addDefaultLicenseMatchers="false">
+  <asl20/>
+</rat:report>
+---
+
 * License Families
 
   Any defined Ant type that implements the <<<ILicenseFamily>>>