This is an automated email from the ASF dual-hosted git repository.
ottlinger pushed a commit to branch feature/TENTACLES-26
in repository https://gitbox.apache.org/repos/asf/creadur-tentacles.git
The following commit(s) were added to refs/heads/feature/TENTACLES-26 by this
push:
new 11f442f TENTACLES-26: Fix typos and align site and README
11f442f is described below
commit 11f442f808d5c3284e9be46c7e0fd0668b6a14b7
Author: P. Ottlinger <[email protected]>
AuthorDate: Sun Jul 19 11:59:34 2026 +0200
TENTACLES-26: Fix typos and align site and README
---
README.md | 9 +++++----
src/site/apt/index.apt.vm | 8 ++++----
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index e8aae97..e30694b 100644
--- a/README.md
+++ b/README.md
@@ -10,14 +10,15 @@ GA: [![Github Action master branch
status](https://github.com/apache/creadur-ten
# Running with at least JDK 17
-The tool will download all the archives from a staging repo, unpack
+The tool will download all the archives from a nexus/staging repo, unpack
them and create a little report of what is there.
- java -ea -jar apache-tentacles-0.2-SNAPSHOT.jar
https://repository.apache.org/content/repositories/orgapacheopenejb-090
+ java -ea -jar apache-tentacles-0.2-SNAPSHOT-jar-with-dependencies.jar
https://repository.apache.org/content/repositories/orgapacheflink-1935/
+ java -ea -jar apache-tentacles-0.2-SNAPSHOT-jar-with-dependencies.jar
https://repository.apache.org/content/repositories/releases/org/apache/creadur/tentacles/
Assertions must be enabled.
-The tool is not specific to maven and will simply recursively walk
+The tool is not specific to Maven and will simply recursively walk
the provided URL and download all files matching the following
pattern:
@@ -82,7 +83,7 @@ also be unpacked.
## Reports
The "main" report is currently called `archives.html` and will list
-all of the top-level binaries, their LICENSE and NOTICE files and any
+all the top-level binaries, their LICENSE and NOTICE files and any
LICENSE and NOTICE files of any binaries they may contain.
Validation of the output at this point is all still manual. One of
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 1b35a7c..a330a21 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -23,7 +23,7 @@ Introduction to Apache Tentacles™
* Running
- Apache Tentacles™ will download all the archives from a staging repo,
unpack them and create a little report of what is there.
+ Apache Tentacles™ will download all the archives from a nexus/staging
repo, unpack them and create a little report of what is there.
+------------------------------------------+
java -ea -jar
apache-tentacles-${previousTentaclesVersion}-jar-with-dependencies.jar
https://repository.apache.org/content/repositories/orgapacheopenejb-090
@@ -31,7 +31,7 @@ java -ea -jar
apache-tentacles-${previousTentaclesVersion}-jar-with-dependencies
Assertions must be enabled.
- The tool is not specific to maven and will simply recursively walk the
provided URL and download all files matching the following pattern:
+ The tool is not specific to Maven and will simply recursively walk the
provided URL and download all files matching the following pattern:
+------------------------------------------+
.*\.(jar|zip|war|ear|tar.gz)
@@ -98,7 +98,7 @@
content/foo.zip.contents/lib/bar.jar.contents/org/bar/Some.class
* Reports
- The "main" report is currently called archives.html and will list all of the
top-level binaires, their LICENSE and NOTICE files and any LICENSE and NOTICE
files of any binaries they may contain.
+ The "main" report is currently called archives.html and will list all the
top-level binaries, their LICENSE and NOTICE files and any LICENSE and NOTICE
files of any binaries they may contain.
Validation of the output at this point is all still manual. One of the first
improvements would be to automatically flag any binaries that:
@@ -116,7 +116,7 @@
content/foo.zip.contents/lib/bar.jar.contents/org/bar/Some.class
The Declared section lists the single LICENSE file that was supplied by the
binary itself. As the tool works recursively, it will also collect any LICENSE
file text from any binaries contained in the foo.zip. Well call these "sub"
LICENSES for simplicity.
- Some attempt is made to figure out if the text from sub LICENSE files are
contained in the declared LICENSE file. If the sub license text is contained in
the declared LICENSE file it is not listed as Undeclared.
+ Some attempt is made to figure out if the text from sub LICENSE files are
contained in the declared LICENSE file. If the sublicense text is contained in
the declared LICENSE file it is not listed as Undeclared.
The matching is not complete or perfect, but does help in more quickly seeing
where there might be a missing LICENSE text that should be declared.
