You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 13:26:48 UTC
(maven-jdeps-plugin) branch master updated (cc61fc0 -> 22fb5df)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jdeps-plugin.git
from cc61fc0 Enable Maven 4 build (#90)
new 53fea48 Rename the site documents ahead of converting them
new 22fb5df Port the site documentation from APT to Markdown
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/index.apt.vm | 70 -------------
src/site/apt/usage.apt.vm | 67 -------------
src/site/markdown/index.md | 39 ++++++++
.../basic/pom.xml => site/markdown/usage.md.vm} | 108 +++++++++++----------
4 files changed, 96 insertions(+), 188 deletions(-)
delete mode 100644 src/site/apt/index.apt.vm
delete mode 100644 src/site/apt/usage.apt.vm
create mode 100644 src/site/markdown/index.md
copy src/{it/basic/pom.xml => site/markdown/usage.md.vm} (52%)
(maven-jdeps-plugin) 02/02: Port the site documentation from APT to Markdown
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jdeps-plugin.git
commit 22fb5df4bbc6a5fc079c7257d1c7b31c1a4ec2a6
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:00 2026 +0200
Port the site documentation from APT to Markdown
3 page(s) converted with doxia-converter and then cleaned up by hand:
- <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
becomes [text](url)
- the ASF license header becomes a single block HTML comment
- a page whose only Velocity reference was ${project.name} is now a plain
.md with the title spelled out
- a page that keeps a reference stays a .vm. Velocity reads ## as a line
comment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#
- references APT rendered literally are escaped, so they do not resolve
Verified by building the site before and after and comparing every
generated page: the visible text and the link targets are unchanged apart
from <b>/<i> becoming <strong>/<em> and quotes in prose picking up the
Markdown module's typographic substitution.
---
src/site/markdown/index.md | 109 +++++++++++++------------------------
src/site/markdown/usage.md.vm | 124 +++++++++++++++++++-----------------------
2 files changed, 96 insertions(+), 137 deletions(-)
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 8fede59..6872ec8 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,70 +1,39 @@
- ------
- Introduction
- ------
- Robert Scholte
- ------
- 2015-02-05
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-${project.name}
-
- The JDeps Plugin uses the jdeps tool to analyze classes for internal API calls.
- For more information about the standard jdeps tool, please refer to
- {{{https://wiki.openjdk.java.net/display/JDK8/Java+Dependency+Analysis+Tool}Java+Dependency+Analysis+Tool}}.
-
- <<NOTE:>> The jdeps tool is available since JDK8.
-
- <<NOTE:>> The plugin has {{{http://maven.apache.org/guides/mini/guide-using-toolchains.html}toolchains support}}.
- When using Apache Maven 3.2.6, the build doesn't need to use toolchains itself, ie. use the <<<maven-toolchain-plugin>>>;
- the <<<maven-jdeps-plugin>>> can pick up a <<<jdk>>> toolchain defined in <<<toolchain.xml>>> independently from build
- configuration: it chooses a <<<jdk>>> toolchain from available configurations that have a version <<<1.8>>> or above.
-
-* Goals Overview
-
- The JDeps Plugin has 2 goals:
-
- * {{{./jdkinternals-mojo.html}jdeps:jdkinternals}} checks if main classes depend on internal JDK classes.
-
- * {{{./test-jdkinternals-mojo.html}jdeps:test-jdkinternals}} checks if test classes depend on internal JDK classes.
-
- []
-
-* Usage
-
- General instructions on how to use the JDeps Plugin can be found on the {{{./usage.html}usage page}}. Some more
- specific use cases are described in the examples given below. Last but not least, users occasionally contribute
- additional examples, tips or errata to the
- {{{http://docs.codehaus.org/display/MAVENUSER/JDeps+Plugin}plugin's wiki page}}.
-
- In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
- free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
- already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
- the {{{./mailing-lists.html}mail archive}}.
-
- If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
- {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
- concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
- entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
- Of course, patches are welcome, too. Contributors can check out the project from our
- {{{./scm.html}source repository}} and will find supplementary information in the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
+<!--
+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 Maven JDeps Plugin
+The JDeps Plugin uses the jdeps tool to analyze classes for internal API calls. For more information about the standard jdeps tool, please refer to [Java+Dependency+Analysis+Tool](https://wiki.openjdk.java.net/display/JDK8/Java+Dependency+Analysis+Tool).
+
+**NOTE:** The jdeps tool is available since JDK8.
+
+**NOTE:** The plugin has [toolchains support](http://maven.apache.org/guides/mini/guide-using-toolchains.html). When using Apache Maven 3.2.6, the build doesn't need to use toolchains itself, ie. use the `maven-toolchain-plugin`; the `maven-jdeps-plugin` can pick up a `jdk` toolchain defined in `toolchain.xml` independently from build configuration: it chooses a `jdk` toolchain from available configurations that have a version `1.8` or above.
+
+## Goals Overview
+
+The JDeps Plugin has 2 goals:
+
+- [jdeps:jdkinternals](./jdkinternals-mojo.html) checks if main classes depend on internal JDK classes.
+- [jdeps:test-jdkinternals](./test-jdkinternals-mojo.html) checks if test classes depend on internal JDK classes.
+## Usage
+
+General instructions on how to use the JDeps Plugin can be found on the [usage page](./usage.html). Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the [plugin's wiki page](http://docs.codehaus.org/display/MAVENUSER/JDeps+Plugin).
+
+In case you still have questions regarding the plugin's usage, please have a look at the [FAQ](./faq.html) and feel free to contact the [user mailing list](./mailing-lists.html). The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the [mail archive](./mailing-lists.html).
+
+If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our [issue tracker](./issue-management.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are wel [...]
diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index 9a9944b..bf58667 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -1,67 +1,57 @@
- ------
- Usage
- ------
- Robert Scholte
- ------
- 2015-02-05
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-
-Usage
-
- The JDeps Plugin verifies classes using the jdeps tool. The following examples describe the basic usage of the
- Plugin.
-
-* Verify Classes As Part Of The Build
-
- To verify the classes as part of build, you should add the JDeps Plugin in the \<build\> section of your pom:
-
-+-----+
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <executions>
- <execution>
- <goals>
- <goal>jdkinternals</goal> <!-- verify main classes -->
- <goal>test-jdkinternals</goal> <!-- verify test classes -->
- </goals>
- </execution>
- </executions>
- <configuration>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-+-----+
-
- If there is any usage detected of an internal API, the build will stop and fail.
+<!--
+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.
+-->
+
+# Usage
+
+The JDeps Plugin verifies classes using the jdeps tool. The following examples describe the basic usage of the Plugin.
+
+Verify Classes As Part Of The Build
+-----------------------------------
+
+To verify the classes as part of build, you should add the JDeps Plugin in the <build> section of your pom:
+
+```xml
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>jdkinternals</goal> <!-- verify main classes -->
+ <goal>test-jdkinternals</goal> <!-- verify test classes -->
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+```
+
+If there is any usage detected of an internal API, the build will stop and fail.
(maven-jdeps-plugin) 01/02: Rename the site documents ahead of converting them
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jdeps-plugin.git
commit 53fea48f89f44037b418b681c60304ba78ec3d4a
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:00 2026 +0200
Rename the site documents ahead of converting them
A pure rename, so that git records it and `git log --follow` and `git blame` still
reach the history of each page after the conversion that follows. The content is
still APT at this point and the site does not build between the two commits.
---
src/site/{apt/index.apt.vm => markdown/index.md} | 0
src/site/{apt/usage.apt.vm => markdown/usage.md.vm} | 0
2 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/src/site/apt/index.apt.vm b/src/site/markdown/index.md
similarity index 100%
rename from src/site/apt/index.apt.vm
rename to src/site/markdown/index.md
diff --git a/src/site/apt/usage.apt.vm b/src/site/markdown/usage.md.vm
similarity index 100%
rename from src/site/apt/usage.apt.vm
rename to src/site/markdown/usage.md.vm