You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by po...@apache.org on 2024/01/14 20:56:27 UTC

(creadur-rat) branch feature/RAT-343_improveDocs updated (cf66ca60 -> ea3a5d3f)

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

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


    from cf66ca60 RAT-343: Enhance documentation about new configuration options
     new 370d03c8 RAT-343: Add intro
     new ea3a5d3f RAT-343: Hide link to format howto

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../src/site/apt/examples/custom-license.apt.vm              | 12 ++++++++++++
 1 file changed, 12 insertions(+)


(creadur-rat) 02/02: RAT-343: Hide link to format howto

Posted by po...@apache.org.
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 ea3a5d3f9c770607fbecda89ae416f28d91f75bf
Author: P. Ottlinger <po...@apache.org>
AuthorDate: Sun Jan 14 21:56:22 2024 +0100

    RAT-343: Hide link to format howto
---
 apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

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 a1803800..ac9630e1 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
@@ -127,5 +127,4 @@ Overview of configuration options
 
   * Each license has one matcher.
 
-
-https://maven.apache.org/doxia/references/apt-format.html
+~~ https://maven.apache.org/doxia/references/apt-format.html


(creadur-rat) 01/02: RAT-343: Add intro

Posted by po...@apache.org.
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 <po...@apache.org>
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