This is an automated email from the ASF dual-hosted git repository.

pottlinger pushed a commit to branch feature/RAT-343_improveDocs
in repository https://gitbox.apache.org/repos/asf/creadur-rat.git

commit 370d03c8743333e317519c0b6bb8aee3c5da001d
Author: P. Ottlinger <[email protected]>
AuthorDate: Sun Jan 14 21:52:08 2024 +0100

    RAT-343: Add intro
---
 .../src/site/apt/examples/custom-license.apt.vm             | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm 
b/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
index f6ed6b4a..a1803800 100644
--- a/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
+++ b/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
@@ -116,3 +116,16 @@ Approved License Families
     </plugins>
   </build>
 ------------------------------------------------------------------
+
+Overview of configuration options
+
+  When defining custom licenses, remember the following architecture 
constraints:
+
+  * Each license is associated with a family.  Multiple licenses can be 
associated with a family.
+
+  * Each license may have a notes element.
+
+  * Each license has one matcher.
+
+
+https://maven.apache.org/doxia/references/apt-format.html

Reply via email to