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 0457e3c4 RAT-479: Remove unused/outdated README text files (#522)
0457e3c4 is described below
commit 0457e3c48307dceaf2980576051e08c766e8ec73
Author: Claude Warren <[email protected]>
AuthorDate: Sat Sep 13 16:43:41 2025 +0200
RAT-479: Remove unused/outdated README text files (#522)
* RAT-479: Removed unused/outdated README files
---------
Co-authored-by: P. Ottlinger <[email protected]>
Co-authored-by: P. Ottlinger <[email protected]>
---
README.txt | 53 ----------------------------------------
apache-rat/README-ANT.txt | 62 -----------------------------------------------
apache-rat/README-CLI.txt | 46 -----------------------------------
apache-rat/README.txt | 31 ------------------------
apache-rat/pom.xml | 4 ---
pom.xml | 1 -
src/changes/changes.xml | 3 +++
7 files changed, 3 insertions(+), 197 deletions(-)
diff --git a/README.txt b/README.txt
deleted file mode 100644
index c23395a8..00000000
--- a/README.txt
+++ /dev/null
@@ -1,53 +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.
-
- Apache Rat
- ==========
-
-Apache Rat is developed by the Apache Creadur project of the Apache Software
-Foundation. Join us at https://creadur.apache.org and read more about Apache
Rat
-at https://creadur.apache.org/rat.
-
-Release Audit Tool (Rat) is a tool to improve accuracy and efficiency when
checking
-releases. It is heuristic in nature: making guesses about possible problems. It
-will produce false positives and cannot find every possible issue with a
release.
-It's reports require interpretation.
-
-Rat was developed in response to a need felt in the Apache Incubator to be
able to
-review releases for the most common faults less labour intensively. It is
therefore
-highly tuned to the Apache style of releases.
-
-Rat is intended to be self documenting: reports should include introductory
material
-describing their function. Building Rat describes how to run Rat. Running Rat
-describes the options available. These release notes describe the current
state of
-Rat.
-
-A good way to use Rat is to through the source. This allows the code base to be
-easily patched for example to add new generated file matchers. The main jar is
-runnable and self-documenting. This jar is available as a standard alone
binary.
-
-Rat includes a task library for Ant 1.10. This allows Rat reports to be run
against
-a wide variety of resources. See ant-task-examples.xml. To use the Ant tasks,
-Apache Ant 1.10 is required. See https://ant.apache.org/.
-
-For Maven builds, the plugin is recommended.
-
-In response to demands from project quality tool developers, Rat is available
as a
-library (rat-lib jar) suitable for inclusion in tools. Note that binary
compatibility
-is not guaranteed between 0.x releases. The XML output format is not yet in
it's
-final form and so library users are recommended to either use the supplied
-stylesheets or keep in close touch with the code.
-
diff --git a/apache-rat/README-ANT.txt b/apache-rat/README-ANT.txt
deleted file mode 100644
index 59b8e334..00000000
--- a/apache-rat/README-ANT.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-Apache RAT Ant Task Library
-===========================
-
-The Ant Task Library provides a single Ant task and a few supporting Ant types
to run Rat,
-the Release Audit Tool from inside Apache Ant.
-
-Using Ant's resource abstraction the task can be used to check files on disk
as well as tarballs
-or even URLs directly.
-
-Requirements
-------------
-
-The RAT Ant Task Library requires Apache Ant 1.7.1 or higher (it works well
with 1.8.x)
-
-Installation
-------------
-
-There are several ways to use the Antlib:
-
- The traditional way:
-
- <taskdef
- resource="org/apache/rat/anttasks/antlib.xml">
- <classpath>
- <pathelement
location="YOUR-PATH-TO/apache-rat-${project.version}.jar"/>
- </classpath>
- </taskdef>
-
- With this you can use the report task like plain Ant tasks, they'll live
in the default namespace.
- I.e. if you can run exec without any namespace prefix, you can do so for
report as well.
- Similar, but assigning a namespace URI
-
- <taskdef
- uri="antlib:org.apache.rat.anttasks"
- resource="org/apache/rat/anttasks/antlib.xml">
- <classpath>
- <pathelement
location="YOUR-PATH-TO/apache-rat-${project.version}.jar"/>
- </classpath>
- </taskdef>
-
- This puts your task into a separate namespace than Ant's namespace. You
would use the tasks like
-
- <project
- xmlns:rat="antlib:org.apache.rat.anttasks"
- xmlns="antlib:org.apache.tools.ant">
- ...
- <rat:report>
- <fileset dir="src"/>
- </rat:report>
-
- or a variation thereof.
- Using Ant's autodiscovery. Place apache-rat-tasks.jar and all dependencies
into a directory
- and use ant -lib YOUR-PATH-TO/apache-rat-${project.version}.jar
- or copy apache-rat-${project.version}.jar into ANT_HOME/lib.
-
- Then in your build file, simply declare the namespace on the project tag:
-
- <project
- xmlns:rat="antlib:org.apache.rat.anttasks"
- xmlns="antlib:org.apache.tools.ant">
-
- All tasks of this library will automatically be available in the "rat"
namespace without any taskdef.
diff --git a/apache-rat/README-CLI.txt b/apache-rat/README-CLI.txt
deleted file mode 100644
index 1b1261c0..00000000
--- a/apache-rat/README-CLI.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-About Apache RAT™
-================
-
-RAT audits software distributions, with a special interest in headers.
-If this isn't quite what you're looking for then take a look at the
-other products developed by Apache Creadur™,
-including Apache Whisker™ which audits and generates legal (for example
LICENSE)
-documents for complex software distributions.
-
-Running from the Command Line
------------------------------
-
-Run from the command line with:
-
-java -jar apache-rat-${project.version}.jar --help
-
-This will output a help message detailing the command line options available
to you.
-
-Adding license headers
-----------------------
-
-RAT can be used to automatically add license headers to files that do not
currently have them.
-Only files that are not excluded by the RAT configurations will be affected.
-
-To add license headers use a command such as:
-
-java -jar apache-rat-${project.version}.jar --addlicense
- --copyright "Copyright 2008 Foo" --force
- /path/to/project
-
-This command will add the license header directly to the source files.
-If you prefer to see which files will be changed and how then remove the
"--force" option.
-Using multiple excludes from a file
-
-It is common to use the RAT with the maven or ant plugins and specify a series
of files to exclude
-(such as a README or version control files).
-If you are using the RAT application instead of a plugin you can specify a
series of regex excludes
-in a file and specify that with the -E option.
-
-java -jar apache-rat-${project.version}.jar
- -E /path/to/project/.rat-excludes
- -d /path/to/project
-
-Command Line Options
-====================
-see https://creadur.apache.org/rat/apache-rat/index.html#Command_Line_Options
diff --git a/apache-rat/README.txt b/apache-rat/README.txt
deleted file mode 100644
index 1ae89225..00000000
--- a/apache-rat/README.txt
+++ /dev/null
@@ -1,31 +0,0 @@
-README file for Apache Creadur RAT
-==================================
-
-The jar in this archive can be used both:
- * stand-alone command line (CLI)
- * with Ant as an Ant task
-
-Stand-alone (CLI) usage
-=======================
-
-java -jar apache-rat-${project.version}.jar --help
-
-Command Line Options
-====================
-
-Available CLI options are documented at
-https://creadur.apache.org/rat/apache-rat/index.html#Command_Line_Options
-
-For further details, please see the the website:
-https://creadur.apache.org/rat/apache-rat/index.html
-
-Apache Rat Ant Task Library
-===========================
-
-It can also be used in conjunction with Ant:
-
-ant -lib apache-rat-${project.version}.jar ...
-
-For more details, please see the file README-ANT.txt or the website:
-
-https://creadur.apache.org/rat/apache-rat-tasks/index.html
diff --git a/apache-rat/pom.xml b/apache-rat/pom.xml
index 269018f7..99f85bc8 100644
--- a/apache-rat/pom.xml
+++ b/apache-rat/pom.xml
@@ -326,10 +326,6 @@
<artifactId>apache-rat-plugin</artifactId>
<configuration>
<excludes>
- <!-- These files only describe how to use the project and they
- have no license headers -->
- <exclude>README-ANT.txt</exclude>
- <exclude>README-CLI.txt</exclude>
<!-- files that are examples of output from the tool -->
<exclude>src/site/examples/**</exclude>
<exclude>src/site/apt/*.txt</exclude>
diff --git a/pom.xml b/pom.xml
index 3c4ba5e9..b9fd1e1e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -554,7 +554,6 @@ agnostic home for software distribution comprehension and
audit tools.
<excludes>
<exclude>.asf.yaml</exclude>
<!-- rat:check does not seem to use exclusions from modules -->
- <exclude>apache-rat/README*.txt</exclude>
<exclude>apache-rat-core/src/test/resources/**</exclude>
<exclude>apache-rat*/target/**</exclude>
<exclude>apache-rat-plugin/src/test/resources/**</exclude>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 487a4190..94ef24e0 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-479" type="add" dev="claudenw">
+ Cleanup documentation and remove deprecated and outdated README files
in RAT's main repository.
+ </action>
<action issue="RAT-406" type="add" dev="claudenw">
Added integration tests for command line combinations to ensure
marking a license as denied works.
</action>
