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 86ba309c RAT-481: Fix 404s in generated site and menu structure (#540)
86ba309c is described below
commit 86ba309c5f3d7cc510acab28cf1cf2160fae92f4
Author: P. Ottlinger <[email protected]>
AuthorDate: Sun Oct 5 00:00:48 2025 +0200
RAT-481: Fix 404s in generated site and menu structure (#540)
* RAT-379: Remove obsolete groovy file to copy resources.
* RAT-481: Fix layout errors
* RAT-481: Add missing pages for testdata submodule
* RAT-481: Enhance scripts and apply knowledge from other subprojects
* RAT-481: Fix broken links and missing menu entries
* RAT-481: Add missing headline to example overview page
* RAT-481: Fix broken link in template
* RAT-481: Fix broken link in template
* RAT-481: Fix more broken links in generated pages
* RAT-481: Fix linking error
* RAT-481: Fix more 404 to Ant submodule
* RAT-481: Fix wrong static link of Report task in antlib
* RAT-481: Remove non-existing reference
* RAT-481: Replace non-working unicode with HTML entity
* RAT-481: Add changelog for fixes
* RAT-481: Remove old/invalid configuration option as we migrated to v3 of
changes-plugin
* RAT-481: Document how to use SNAPSHOT versions
---
.buildtools/generateStagingSiteInWebpageRepo | 33 ++++++++++-
.../generateStagingSiteInWebpageRepo-release | 33 ++++++++++-
.../copyResourcesFromParentProject.groovy | 66 ----------------------
.../org/apache/rat/analysis/TikaProcessor.java | 2 +-
.../main/java/org/apache/rat/mp/RatCheckMojo.java | 3 +-
.../src/site/apt/examples/custom-license.apt.vm | 2 +-
apache-rat-plugin/src/site/apt/examples/index.apt | 6 +-
apache-rat-plugin/src/site/fml/faq.fml | 14 ++---
apache-rat-plugin/src/site/site.xml | 2 +-
.../src/templates/apt/index.apt.vm.vm | 18 ++++++
.../src/templates/apt/mvn_options.apt.vm | 2 +-
apache-rat-tasks/src/site/site.xml | 4 +-
.../src/templates/apt/ant_options.apt.vm | 2 +-
apache-rat-tasks/src/templates/apt/index.apt.vm.vm | 4 +-
.../src/site/apt/index.apt.vm | 21 ++++---
.../src/site/site.xml | 6 +-
.../src/templates/apt/default_licenses.apt.vm | 2 +-
apache-rat/src/templates/apt/index.apt.vm.vm | 11 ++--
.../src/templates/apt/standard_collections.apt.vm | 1 +
pom.xml | 2 -
src/changes/changes.xml | 3 +
src/site/apt/index.apt.vm | 15 +++--
src/site/site.xml | 2 +-
23 files changed, 129 insertions(+), 125 deletions(-)
diff --git a/.buildtools/generateStagingSiteInWebpageRepo
b/.buildtools/generateStagingSiteInWebpageRepo
index 6a2ee494..b632493a 100755
--- a/.buildtools/generateStagingSiteInWebpageRepo
+++ b/.buildtools/generateStagingSiteInWebpageRepo
@@ -16,6 +16,33 @@
#
# DEVHINT: RAT-302: Do not use modern JDK due to the javadoc problem; JDK8 and
16 are okay
# DEVHINT: package build is required as site target requires access to the
completed jar package.
-./mvnw clean package site site:stage
-cp -rvf target/staging/* ../creadur-site/rat017/
-cp -rvf src/site/javadocFont/* ../creadur-site/rat017/apidocs/
+./mvnw -B clean package site site:stage
+
+# DEVHINT: with trailing slash please!
+targetDirectory=../creadur-site/rat017/
+
+echo "Copying site resources into asf-site repo under $targetDirectory"
+cp -rvf target/staging/* $targetDirectory > /dev/null
+echo "DONE."
+
+echo
+echo "Copying JS/CSS resources into generated reports"
+for subdirectory in "apidocs" "testapidocs" "xref" "xref-test"
+ do
+ echo "> $subdirectory"
+ mkdir -p $targetDirectory/$subdirectory && cp -rvf src/site/javadocFont/*
$targetDirectory/$subdirectory/ > /dev/null
+ done
+echo "DONE."
+
+echo
+echo "Fixing missing JS/CSS resources in all subprojects"
+for module in "apache-rat" "apache-rat-core" "apache-rat-plugin"
"apache-rat-tasks" "apache-rat-testdata" "apache-rat-tools"
+ do
+ echo ">> Module: $module"
+ for targetSubdirectory in "apidocs" "testapidocs" "xref" "xref-test"
+ do
+ mkdir -p $targetDirectory$module/$targetSubdirectory && cp -rvf
src/site/javadocFont/* $targetDirectory$module/$targetSubdirectory/ > /dev/null
+ done
+ done
+
+echo "DONE."
\ No newline at end of file
diff --git a/.buildtools/generateStagingSiteInWebpageRepo-release
b/.buildtools/generateStagingSiteInWebpageRepo-release
index 8b2e7fa1..209f0594 100755
--- a/.buildtools/generateStagingSiteInWebpageRepo-release
+++ b/.buildtools/generateStagingSiteInWebpageRepo-release
@@ -16,6 +16,33 @@
#
# DEVHINT: RAT-302: Do not use modern JDK due to the javadoc problem; JDK8 and
16 are okay
# DEVHINT: package build is required as site target requires access to the
completed jar package.
-./mvnw clean package site site:stage
-cp -rvf target/staging/* ../creadur-site/rat/
-cp -rvf src/site/javadocFont/* ../creadur-site/rat/apidocs/
+./mvnw -B clean package site site:stage
+
+# DEVHINT: with trailing slash please!
+targetDirectory=../creadur-site/rat/
+
+echo "Copying site resources into asf-site repo under $targetDirectory"
+cp -rvf target/staging/* $targetDirectory > /dev/null
+echo "DONE."
+
+echo
+echo "Copying JS/CSS resources into generated reports"
+for subdirectory in "apidocs" "testapidocs" "xref" "xref-test"
+ do
+ echo "> $subdirectory"
+ mkdir -p $targetDirectory/$subdirectory && cp -rvf src/site/javadocFont/*
$targetDirectory/$subdirectory/ > /dev/null
+ done
+echo "DONE."
+
+echo
+echo "Fixing missing JS/CSS resources in all subprojects"
+for module in "apache-rat" "apache-rat-core" "apache-rat-plugin"
"apache-rat-tasks" "apache-rat-testdata" "apache-rat-tools"
+ do
+ echo ">> Module: $module"
+ for targetSubdirectory in "apidocs" "testapidocs" "xref" "xref-test"
+ do
+ mkdir -p $targetDirectory$module/$targetSubdirectory && cp -rvf
src/site/javadocFont/* $targetDirectory$module/$targetSubdirectory/ > /dev/null
+ done
+ done
+
+echo "DONE."
\ No newline at end of file
diff --git
a/apache-rat-core/src/main/build-grv/copyResourcesFromParentProject.groovy
b/apache-rat-core/src/main/build-grv/copyResourcesFromParentProject.groovy
deleted file mode 100644
index e8501d6c..00000000
--- a/apache-rat-core/src/main/build-grv/copyResourcesFromParentProject.groovy
+++ /dev/null
@@ -1,66 +0,0 @@
-/**
- * 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.
- */
-
-// Copy a set of resource files from the parent project to
target/classes/META-INF,
-// so that they become a part of the generated jar file. See RAT-379 for
details.
-
-import java.nio.file.attribute.FileTime
-import java.nio.file.Files
-import java.nio.file.Path
-import java.nio.file.Paths
-import java.nio.file.StandardCopyOption
-
-final Path sourceDir = Paths.get("${sourceDir}")
-final Path targetDir = Paths.get("${targetDir}")
-
-if (!Files.isDirectory(sourceDir)) {
- final String msg = "Source directory not found: " +
sourceDir.toAbsolutePath()
- System.err.println(msg)
- throw new FileNotFoundException(msg)
-}
-
-// System.out.println("copyResourcesFromParent: Using source directory " +
sourceDir + ", resolved to " + sourceDir.toAbsolutePath())
-// System.out.println("copyResourcesFromParent: Using target directory " +
targetDir + ", resolved to " + targetDir.toAbsolutePath())
-Files.createDirectories(targetDir)
-
-for (StringTokenizer st = new StringTokenizer("${filesToCopy}", ",");
st.hasMoreTokens(); ) {
- final String token = st.nextToken()
- final Path sourceFile = sourceDir.resolve(token)
- if (!Files.isRegularFile(sourceFile)) {
- final String msg = "Source file " + token + " not found in
source directory " + sourceDir
- System.err.println("copyResourcesFromParent: " + msg)
- System.err.println("copyResourcesFromParent: A possible reason
is, that you did clone only the apache-rat-core subproject from Git.")
- throw new FileNotFoundException(msg)
- }
- final Path targetFile = targetDir.resolve(token)
- final boolean replacing = Files.isRegularFile(targetFile)
- if (replacing) {
- final FileTime sourceTime =
Files.getLastModifiedTime(sourceFile)
- final FileTime targetTime =
Files.getLastModifiedTime(targetFile)
- if (sourceTime != null && targetTime != null && sourceTime
>= targetTime) {
- System.out.println("Skipping " + sourceFile + ", as
target " + targetFile + " appears to be up-to-date already.")
- continue
- }
- }
- System.out.println("Copying " + sourceFile
- + " to " + targetFile)
- if (replacing) {
- Files.copy(sourceFile, targetFile,
StandardCopyOption.REPLACE_EXISTING)
- } else {
- Files.copy(sourceFile, targetFile)
- }
-}
diff --git
a/apache-rat-core/src/main/java/org/apache/rat/analysis/TikaProcessor.java
b/apache-rat-core/src/main/java/org/apache/rat/analysis/TikaProcessor.java
index d437c773..9cad66cf 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/TikaProcessor.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/TikaProcessor.java
@@ -167,7 +167,7 @@ public final class TikaProcessor {
try {
return Charset.forName(charsetMatch.getName());
} catch (UnsupportedCharsetException e) {
- DefaultLog.getInstance().warn(String.format("Unsupported
character set '%s' in file '%s'. Will use system default encoding.",
+ DefaultLog.getInstance().warn(String.format("Unsupported
character set '%s' in file '%s'. Will use system default encoding.",
charsetMatch.getName(), documentName));
}
}
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
index bb17a6b5..13ea48b2 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
@@ -42,8 +42,7 @@ import static java.lang.String.format;
/**
* Run RAT to perform a violation check.
* <p>
- * This documentation mentions data types for some arguments. An <a
href="data_types.html">explanation of the data types</a> is included
- * in this documentation package.
+ * This documentation mentions data types for some arguments.
* </p>
*/
@Mojo(name = "check", defaultPhase = LifecyclePhase.VALIDATE, threadSafe =
true)
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 59de22aa..4b9932c0 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
@@ -31,7 +31,7 @@ Custom License Matchers
Unlike earlier versions (before 0.16) no custom implementations are required
to define
custom licenses.
- There is a file that defines all the standard licenses:
{{{https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml}default.xml}}.
The pom.xml implementations vary slightly from the configuration because the
pom does not allow attributes on the configuration entries. For a full mapping
of the command line options to the Maven options see the
{{{/apache-rat/name_xref.html}Option Name Cross-Reference}}
+ There is a file that defines all the standard licenses:
{{{https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml}default.xml}}.
The pom.xml implementations vary slightly from the configuration because the
pom does not allow attributes on the configuration entries. For a full mapping
of the command line options to the Maven options see the
{{{../../apache-rat/name_xref.html}Option Name Cross-Reference}}
Please be aware that custom licenses need to have <<unique names>>,
otherwise a warning is issued and your custom definitions are ignored in favour
of the standard license definitions.
diff --git a/apache-rat-plugin/src/site/apt/examples/index.apt
b/apache-rat-plugin/src/site/apt/examples/index.apt
index 1d7e071b..dcfb8546 100644
--- a/apache-rat-plugin/src/site/apt/examples/index.apt
+++ b/apache-rat-plugin/src/site/apt/examples/index.apt
@@ -14,10 +14,12 @@
~~ limitations under the License.
-----------------------
- Maven Examples
+ Maven Examples Overview
-----------------------
- The following examples should provide a better understanding of some usages
of the RAT Maven Plugin.
+Maven Examples Overview
+
+ The following examples should provide a better understanding of some usages
of the RAT Maven Plugin.
* {{{./basic.html}Basic use}} of the <<apache-rat:check>> goal.
diff --git a/apache-rat-plugin/src/site/fml/faq.fml
b/apache-rat-plugin/src/site/fml/faq.fml
index 7ef1530d..8cb74888 100644
--- a/apache-rat-plugin/src/site/fml/faq.fml
+++ b/apache-rat-plugin/src/site/fml/faq.fml
@@ -18,7 +18,7 @@
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="what">
- <question>What is Rat?</question>
+ <question>What is RAT?</question>
<answer>
<p>
Basically, you can think of it as a tool that checks,
@@ -33,10 +33,10 @@
</answer>
</faq>
<faq id="where">
- <question>Where do I find Apache Rat?</question>
+ <question>Where do I find Apache RAT?</question>
<answer>
<p>
- Apache Rat is now part of the
+ Apache RAT is now part of the
<a href='https://creadur.apache.org'>Apache Creadur</a> project,
a home for all sorts of software that helps audit and review
software distributions.
@@ -44,11 +44,11 @@
</answer>
</faq>
<faq id="why">
- <question>Why should I use the Maven plugin to run Apache Rat?</question>
+ <question>Why should I use the Maven plugin to run Apache RAT?</question>
<answer>
- <p>Because it makes running Rat trivial. Basically, you just
+ <p>Because it makes running RAT trivial. Basically, you just
add the plugin to the <code>build/plugins</code> section
- of your POM and run <code>mvn apache-rat:check</code>. Using Rat
+ of your POM and run <code>mvn apache-rat:check</code>. Using RAT
cannot be simpler.
</p>
</answer>
@@ -68,7 +68,7 @@
</answer>
</faq>
<faq id="customLicense">
- <question>Can I use Rat to validate against a custom license
header?</question>
+ <question>Can I use RAT to validate against a custom license
header?</question>
<answer>
<p>See <a href="examples/custom-license.html">this example</a> to see
how.</p>
</answer>
diff --git a/apache-rat-plugin/src/site/site.xml
b/apache-rat-plugin/src/site/site.xml
index 26e43efe..61a35446 100644
--- a/apache-rat-plugin/src/site/site.xml
+++ b/apache-rat-plugin/src/site/site.xml
@@ -22,11 +22,11 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
- <item name="Usage" href="usage.html"/>
<item name="Maven Options" href="mvn_options.html"/>
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
+ <item name="Introduction" href="examples/index.html"/>
<item name="Basic use" href="examples/basic.html"/>
<item name="Running the plugin automatically"
href="examples/verify.html"/>
<item name="Adding a report to the site" href="examples/site.html"/>
diff --git a/apache-rat-plugin/src/templates/apt/index.apt.vm.vm
b/apache-rat-plugin/src/templates/apt/index.apt.vm.vm
index 42540601..edf8f99c 100644
--- a/apache-rat-plugin/src/templates/apt/index.apt.vm.vm
+++ b/apache-rat-plugin/src/templates/apt/index.apt.vm.vm
@@ -118,3 +118,21 @@ Configuration Options
* Adding the report to the {{{./examples/site.html}generated site}}.
* Applying a {{{./examples/custom-license.html}custom license}}.
+
+Using SNAPSHOT versions
+
+ In case you want to try out current development versions, you need to
adapt your pom.xml in order to include the ASF snapshot repossitory:
+
+------------------------------------------------------------------
+ <pluginRepositories>
+ <pluginRepository>
+ <id>apache.snapshots</id>
+
<url>https://repository.apache.org/content/repositories/snapshots</url>
+ <snapshots>
+ <enabled>true</enabled>
+ <updatePolicy>always</updatePolicy>
+ <checksumPolicy>warn</checksumPolicy>
+ </snapshots>
+ </pluginRepository>
+ </pluginRepositories>
+------------------------------------------------------------------
diff --git a/apache-rat-plugin/src/templates/apt/mvn_options.apt.vm
b/apache-rat-plugin/src/templates/apt/mvn_options.apt.vm
index 70660a12..4a22a214 100644
--- a/apache-rat-plugin/src/templates/apt/mvn_options.apt.vm
+++ b/apache-rat-plugin/src/templates/apt/mvn_options.apt.vm
@@ -62,7 +62,7 @@ Maven Options
${desc}
#if(${type.displayName} == "StandardCollection")
- A complete description of each of the {{{./standard_collections.html}standard
collection}} types is available.
+ A complete description of each of the
{{{../apache-rat/standard_collections.html}standard collection}} types is
available.
#end
#end
diff --git a/apache-rat-tasks/src/site/site.xml
b/apache-rat-tasks/src/site/site.xml
index 222b051d..3301ec2b 100644
--- a/apache-rat-tasks/src/site/site.xml
+++ b/apache-rat-tasks/src/site/site.xml
@@ -15,13 +15,13 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT\u2122 Task
Library for Apache Ant">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™ Task
Library for Apache Ant">
<body>
<head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="Report Task" href="report.html"/>
+ <item name="Report Task" href="examples/report.html"/>
</menu>
<menu name="Examples">
<item name="Basic Usage" href="examples/basic.html"/>
diff --git a/apache-rat-tasks/src/templates/apt/ant_options.apt.vm
b/apache-rat-tasks/src/templates/apt/ant_options.apt.vm
index 2a737793..72e5395f 100644
--- a/apache-rat-tasks/src/templates/apt/ant_options.apt.vm
+++ b/apache-rat-tasks/src/templates/apt/ant_options.apt.vm
@@ -107,7 +107,7 @@ Ant Elements and Attributes
${desc}
#if(${type.displayName} == "StandardCollection")
- A complete description of each of the {{{./standard_collections.html}standard
collection types}} is available.
+ A complete description of each of the
{{{../apache-rat/standard_collections.html}standard collection types}} is
available.
#end
#end
diff --git a/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
b/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
index 2be95c04..8d68ecce 100644
--- a/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
+++ b/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
@@ -17,7 +17,7 @@
#set($stringUtils = ${rat.stringUtils})
#set($newTab = ${rat.doubleLine}+" * ")
- -----
+ -----
Apache RAT Ant Task Library
-----
Apache RAT Overview
@@ -196,7 +196,7 @@ Excluding files from consideration
* Using standard exclusions
- RAT defines a number of {{{../apache-rat/standard_collections}standard
collections}} that can be used to exclude files based on
+ RAT defines a number of {{{../apache-rat/standard_collections.html}standard
collections}} that can be used to exclude files based on
a standard pattern. For example to exclude all the files associated with the
Git SCM
+------------------------------------------+
diff --git a/apache-rat-plugin/src/site/apt/examples/index.apt
b/apache-rat-testdata/src/site/apt/index.apt.vm
similarity index 59%
copy from apache-rat-plugin/src/site/apt/examples/index.apt
copy to apache-rat-testdata/src/site/apt/index.apt.vm
index 1d7e071b..ce3ecbd2 100644
--- a/apache-rat-plugin/src/site/apt/examples/index.apt
+++ b/apache-rat-testdata/src/site/apt/index.apt.vm
@@ -1,3 +1,4 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~ 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.
@@ -5,25 +6,23 @@
~~ (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
+~~ 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.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- -----------------------
- Maven Examples
- -----------------------
+ -----
+ Introduction
+ -----
- The following examples should provide a better understanding of some usages
of the RAT Maven Plugin.
+Apache RAT Testdata
- * {{{./basic.html}Basic use}} of the <<apache-rat:check>> goal.
+ The testdata submodule contains example data and resources:
- * {{{./verify.html}Automatically running}} the <<apache-rat:check>> goal
- when the project is built.
+ * to be used in tests of RAT itself
- * Adding the report to the {{{./site.html}generated site}}.
-
- * Applying a {{{./custom-license.html}custom license}}.
+ * to represent various languages and file types as input for RAT tests
diff --git a/apache-rat-tasks/src/site/site.xml
b/apache-rat-testdata/src/site/site.xml
similarity index 85%
copy from apache-rat-tasks/src/site/site.xml
copy to apache-rat-testdata/src/site/site.xml
index 222b051d..2518366f 100644
--- a/apache-rat-tasks/src/site/site.xml
+++ b/apache-rat-testdata/src/site/site.xml
@@ -15,16 +15,12 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT\u2122 Task
Library for Apache Ant">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™ Testdata">
<body>
<head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="Report Task" href="report.html"/>
- </menu>
- <menu name="Examples">
- <item name="Basic Usage" href="examples/basic.html"/>
</menu>
<menu ref="reports"/>
</body>
diff --git a/apache-rat/src/templates/apt/default_licenses.apt.vm
b/apache-rat/src/templates/apt/default_licenses.apt.vm
index 5e71975c..fd4baf92 100644
--- a/apache-rat/src/templates/apt/default_licenses.apt.vm
+++ b/apache-rat/src/templates/apt/default_licenses.apt.vm
@@ -22,7 +22,7 @@
Default Licenses and Matchers
- The following lists the Licenses, and Matchers that are available by default.
+ The following lists the Licenses and Matchers that are available by default.
* License Properties
diff --git a/apache-rat/src/templates/apt/index.apt.vm.vm
b/apache-rat/src/templates/apt/index.apt.vm.vm
index 2540f8cc..4af01fdf 100644
--- a/apache-rat/src/templates/apt/index.apt.vm.vm
+++ b/apache-rat/src/templates/apt/index.apt.vm.vm
@@ -42,15 +42,15 @@ Apache RAT™ Overview
Running from the Command Line
- RAT has a number of {{{apache-rat/cli_options.html}command line options}}.
The simplest way to retrieve the list of options
+ RAT has a number of {{{../apache-rat/cli_options.html}command line options}}.
The simplest way to retrieve the list of options
is to run the help command:
+------------------------------------------+
java -jar apache-rat/target/apache-rat-${project.version}.jar --help
+------------------------------------------+
- This will output a help message similar to the
{{{apache-rat/cli_options.html}command line options}} document as well as
- information from the {{{apache-rat/standard_collections.html}standard
collections documentation}}.
+ This will output a help message similar to the
{{{../apache-rat/cli_options.html}command line options}} document as well as
+ information from the {{{../apache-rat/standard_collections.html}standard
collections documentation}}.
options available to you.
Adding license headers
@@ -76,7 +76,7 @@ Excluding files from consideration
By default RAT command line includes all the files in the specified
directories. This is not necessarily
the case for the Maven, Ant, or other plugins. To exclude specific files use
the one or more of the exclusion
- options. RAT uses a {{{apache-rat/exclusion_expression.html}modified glob
exclusion}} similar to Ant or Git.
+ options. RAT uses a {{{../apache-rat/exclusion_expression.html}modified glob
exclusion}} similar to Ant or Git.
RAT supports exclusion and inclusion. By default all files are processed.
Using the exclude command files can be excluded from
processing. In addition file may be explicitly included. <<Files that are
explicitly included can not be excluded.>>
@@ -107,7 +107,7 @@ java -jar
apache-rat/target/apache-rat-${project.version}.jar \
* Using standard exclusions
- RAT defines a number of {{{apache-rat/standard_collections}standard
collections}} that can be used to exclude files based on
+ RAT defines a number of {{{../apache-rat/standard_collections.html}standard
collections}} that can be used to exclude files based on
a standard pattern. For example to exclude all the files associated with the
git SCM the following could be used.
+------------------------------------------+
@@ -175,6 +175,7 @@ Styling output
#foreach ($style in ${rat.styleSheets})
*
{{{https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/${style.arg}.xsl}${style.arg}}}
- ${style.desc}
+
#end
These stylesheets can be specified using the "--output-style" option. The
following example create a pretty printed XML
diff --git a/apache-rat/src/templates/apt/standard_collections.apt.vm
b/apache-rat/src/templates/apt/standard_collections.apt.vm
index 9b8f0b74..c1a16dd1 100644
--- a/apache-rat/src/templates/apt/standard_collections.apt.vm
+++ b/apache-rat/src/templates/apt/standard_collections.apt.vm
@@ -54,4 +54,5 @@ Standard Collections
* Notes
* A file processor will process the associated <<<ignore>>> file for include
and exclude directives
+
* A path matcher will match specific information about the file.
diff --git a/pom.xml b/pom.xml
index 53233d84..1e300522 100644
--- a/pom.xml
+++ b/pom.xml
@@ -272,8 +272,6 @@ agnostic home for software distribution comprehension and
audit tools.
<onlyCurrentVersion>${commons.changes.onlyCurrentVersion}</onlyCurrentVersion>
<maxEntries>${commons.changes.maxEntries}</maxEntries>
<runOnlyAtExecutionRoot>${commons.changes.runOnlyAtExecutionRoot}</runOnlyAtExecutionRoot>
- <!-- RAT-353: v3.x of the plugin will use the correct target link as
parameter team, while v2.x uses teamlist -->
- <teamlist>team.html</teamlist>
</configuration>
<reportSets>
<reportSet>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 7941a58d..d14f7a4e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -72,6 +72,9 @@ The <action> type attribute can be one of:
</release>
-->
<release version="0.17-SNAPSHOT" date="xxxx-yy-zz" description="Current
SNAPSHOT - release to be done">
+ <action issue="RAT-481" type="add" dev="pottlinger">
+ Update scripts to generate RAT's webpage and fix multiple linking,
menu and documentation errors.
+ </action>
<action issue="RAT-128" type="add" dev="claudenw">
Properly distinguish between Apache licenses 1.0, 1.1 and 2.0 and
rename to Apache license in reports.
</action>
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 55f87c85..553170ef 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -78,7 +78,7 @@ Apache RAT™
* A {{{./apache-rat/index.html}command line}} client.
- * An Apache {{{./apache-rat-task/index.html}Ant task library}} ,
+ * An Apache {{{./apache-rat-tasks/index.html}Ant task library}} ,
* An Apache {{{./apache-rat-plugin/index.html}Maven plugin}}.
@@ -108,7 +108,7 @@ Apache RAT™
* Quick Start: Running RAT
There are three user interfaces for RAT: from the
{{{./apache-rat/index.html}command line}},
- from {{{./apache-rat-task/index.html}Ant}}, and from
{{{./apache-rat-plugin/index.html}Maven}}.
+ from {{{./apache-rat-tasks/index.html}Ant}}, and from
{{{./apache-rat-plugin/index.html}Maven}}.
Please see the specific documentation in one of the links above.
@@ -145,12 +145,11 @@ cd creadur-rat
*** Hints and Tips
The project creates several jars that are used later in the build process.
This means that the jars for the version being build should be accessible or a
error concerning a missing jar will be displayed. There are several ways to
avoid this problem.
-
- 1. Include the Apache snapshot repository
(https://repository.apache.org/content/repositories/snapshots<url>https://repository.apache.org/content/repositories/snapshots)
in your Maven build.
-
+
+ 1. Include the Apache snapshot repository
{{{https://repository.apache.org/content/repositories/snapshots}https://repository.apache.org/content/repositories/snapshots}}
in your Maven build.
+
2. Execute the maven install noted above. This will place the current jars in
your local repository.
-
+
3. Run "mvn package" and use the resulting jar in the apache-rat sub-module
for testing.
-
+
If you modify code in one sub-module you need to run "mvn install" in that
module to get it into your repository so that you can use it in later
repository builds. Alternatively, you can run "mvn package", or "mvn install"
on the entire project.
-
diff --git a/src/site/site.xml b/src/site/site.xml
index 773a3835..01e5279b 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -53,7 +53,7 @@
<menu name="RAT from the Command Line" inherit="bottom">
<item name="Command Line Introduction" href="apache-rat/index.html"/>
<item name="Command Line Options" href="apache-rat/cli_options.html"/>
- <item name="Environment Variables" href="apache-rat/env_vars.html" />
+ <item name="Environment Variables" href="apache-rat/env_vars.html"/>
<item name="Exclusion Expressions"
href="apache-rat-core/exclusion_expression.html"/>
<item name="Standard Collections"
href="apache-rat/standard_collections.html"/>
</menu>
