This is an automated email from the ASF dual-hosted git repository.
claude pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
The following commit(s) were added to refs/heads/master by this push:
new 903b4911 RAT-358: add and update documentation (#484)
903b4911 is described below
commit 903b4911cc79ac5a48aebf65d9ed0ee0c0211b97
Author: Claude Warren <[email protected]>
AuthorDate: Thu Sep 11 16:52:28 2025 +0200
RAT-358: add and update documentation (#484)
* updated documentation for RAT-358
* Documented list of phrases that trigger generated file detection.
---
apache-rat/pom.xml | 25 +++++++++++++++++++
.../src/site/apt/detecting_generated_files.apt.vm | 29 ++++++++++++++++++++++
src/site/site.xml | 1 +
3 files changed, 55 insertions(+)
diff --git a/apache-rat/pom.xml b/apache-rat/pom.xml
index 155078d5..3563149d 100644
--- a/apache-rat/pom.xml
+++ b/apache-rat/pom.xml
@@ -298,6 +298,31 @@
</filesets>
</configuration>
</plugin>
+ <plugin>
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-generation-keywords</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${basedir}/src/site/apt</outputDirectory>
+ <overwrite>true</overwrite>
+ <resources>
+ <resource>
+ <!-- target/classes/org/apache/rat/generation-keywords.txt
-->
+
<directory>${project.build.outputDirectory}/org/apache/rat</directory>
+ <includes>
+ <include>generation-keywords.txt</include>
+ </includes>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
<pluginManagement>
<plugins>
diff --git a/apache-rat/src/site/apt/detecting_generated_files.apt.vm
b/apache-rat/src/site/apt/detecting_generated_files.apt.vm
new file mode 100644
index 00000000..fd46a6bd
--- /dev/null
+++ b/apache-rat/src/site/apt/detecting_generated_files.apt.vm
@@ -0,0 +1,29 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~ 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.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ --------------------------
+ Detecting Generated Files
+ --------------------------
+
+How RAT Detects Generated Files
+
+ RAT uses a static list of defined phrases. If a document includes one or more
of the phrases it is considered to be generated.
+ Generated documents are not checked for licenses. The list of phrases is:
+
++------------------------------------------+
+#include( "generation-keywords.txt" )
++------------------------------------------+
diff --git a/src/site/site.xml b/src/site/site.xml
index a0524764..f2076634 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -72,6 +72,7 @@
<item name="Defining New Licenses" href="license_def.html"/>
<item name="Configuration XSD" href="apache-rat/xsd.html"/>
<item name="Default Configuration"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml"/>
+ <item name="Detecting Generated Files"
href="apache-rat/detecting_generated_files.html"/>
</menu>
<menu name="RAT Output" inherit="bottom">
<item name="Standard Output Example"
href="apache-rat/output/example.html"/>
