Author: rfscholte
Date: Thu Feb 5 16:36:48 2015
New Revision: 1657621
URL: http://svn.apache.org/r1657621
Log:
Push to 3.0-SNAPSHOT, since this plugin is requiring Maven3
Add documentation
Added:
maven/plugins/trunk/maven-jdeps-plugin/src/site/
maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/
maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/usage.apt.vm
maven/plugins/trunk/maven-jdeps-plugin/src/site/site.xml
maven/plugins/trunk/maven-jdeps-plugin/src/site/xdoc/
maven/plugins/trunk/maven-jdeps-plugin/src/site/xdoc/download.xml.vm
Modified:
maven/plugins/trunk/maven-jdeps-plugin/pom.xml
Modified: maven/plugins/trunk/maven-jdeps-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeps-plugin/pom.xml?rev=1657621&r1=1657620&r2=1657621&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jdeps-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-jdeps-plugin/pom.xml Thu Feb 5 16:36:48 2015
@@ -31,11 +31,11 @@ under the License.
</parent>
<artifactId>maven-jdeps-plugin</artifactId>
- <version>0.0.1-SNAPSHOT</version>
+ <version>3.0-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
<name>Apache Maven JDeps Plugin</name>
- <description></description>
+ <description>The JDeps Plugin uses the jdeps tool to analyze classes for
internal API calls.</description>
<inceptionYear>2015</inceptionYear>
<prerequisites>
Added: maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/index.apt.vm?rev=1657621&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/index.apt.vm (added)
+++ maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/index.apt.vm Thu Feb 5
16:36:48 2015
@@ -0,0 +1,65 @@
+ ------
+ 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.
+
+* 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 {{{./mail-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 {{{./mail-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-tracking.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
+ {{{./source-repository.html}source repository}} and will find supplementary
information in the
+ {{{http://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
Added: maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/usage.apt.vm?rev=1657621&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/usage.apt.vm (added)
+++ maven/plugins/trunk/maven-jdeps-plugin/src/site/apt/usage.apt.vm Thu Feb 5
16:36:48 2015
@@ -0,0 +1,67 @@
+ ------
+ 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.
Added: maven/plugins/trunk/maven-jdeps-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeps-plugin/src/site/site.xml?rev=1657621&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeps-plugin/src/site/site.xml (added)
+++ maven/plugins/trunk/maven-jdeps-plugin/src/site/site.xml Thu Feb 5
16:36:48 2015
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0
http://maven.apache.org/xsd/decoration-1.0.0.xsd";>
+ <body>
+ <links>
+ <item name="Javadoc Tool"
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"/>
+ </links>
+
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <!-- item name="FAQ" href="faq.html"/ -->
+ <!-- According to http://jira.codehaus.org/browse/MNGSITE-152 -->
+ <item name="License" href="http://www.apache.org/licenses/"/>
+ <item name="Download" href="download.html"/>
+ </menu>
+ <!--
+ <menu name="Examples">
+ </menu>
+ -->
+ </body>
+</project>
Added: maven/plugins/trunk/maven-jdeps-plugin/src/site/xdoc/download.xml.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeps-plugin/src/site/xdoc/download.xml.vm?rev=1657621&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeps-plugin/src/site/xdoc/download.xml.vm (added)
+++ maven/plugins/trunk/maven-jdeps-plugin/src/site/xdoc/download.xml.vm Thu
Feb 5 16:36:48 2015
@@ -0,0 +1,126 @@
+<?xml version="1.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.
+-->
+
+<document>
+ <properties>
+ <title>Download ${project.name} Source</title>
+ </properties>
+ <body>
+ <section name="Download ${project.name} ${project.version} Source">
+
+ <p>${project.name} ${project.version} is distributed in source format.
Use a source archive if you intend to build
+ ${project.name} yourself. Otherwise, simply use the ready-made binary
artifacts from central repository.</p>
+
+ <p>You will be prompted for a mirror - if the file is not found on
yours, please be patient, as it may take 24
+ hours to reach all mirrors.<p/>
+
+ <p>In order to guard against corrupted downloads/installations, it is
highly recommended to
+ <a
href="http://www.apache.org/dev/release-signing#verifying-signature";>verify the
signature</a>
+ of the release bundles against the public <a
href="http://www.apache.org/dist/maven/KEYS";>KEYS</a> used by the Apache Maven
+ developers.</p>
+
+ <p>${project.name} is distributed under the <a
href="http://www.apache.org/licenses/";>Apache License, version 2.0</a>.</p>
+
+ <p></p>We <b>strongly</b> encourage our users to configure a Maven
repository mirror closer to their location, please read <a
href="./guides/mini/guide-mirror-settings.html">How to Use Mirrors for
Repositories</a>.</p>
+
+ <a name="mirror"/>
+ <subsection name="Mirror">
+
+ <p>
+ [if-any logo]
+ <a href="[link]">
+ <img align="right" src="[logo]" border="0"
+ alt="logo"/>
+ </a>
+ [end]
+ The currently selected mirror is
+ <b>[preferred]</b>.
+ If you encounter a problem with this mirror,
+ please select another mirror.
+ If all mirrors are failing, there are
+ <i>backup</i>
+ mirrors
+ (at the end of the mirrors list) that should be available.
+ </p>
+
+ <form action="[location]" method="get" id="SelectMirror">
+ Other mirrors:
+ <select name="Preferred">
+ [if-any http]
+ [for http]
+ <option value="[http]">[http]</option>
+ [end]
+ [end]
+ [if-any ftp]
+ [for ftp]
+ <option value="[ftp]">[ftp]</option>
+ [end]
+ [end]
+ [if-any backup]
+ [for backup]
+ <option value="[backup]">[backup] (backup)</option>
+ [end]
+ [end]
+ </select>
+ <input type="submit" value="Change"/>
+ </form>
+
+ <p>
+ You may also consult the
+ <a href="http://www.apache.org/mirrors/";>complete list of
+ mirrors.</a>
+ </p>
+
+ </subsection>
+
+ <subsection name="${project.name} ${project.version}">
+
+ <p>This is the current stable version of ${project.name}.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th></th>
+ <th>Link</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>${project.name} ${project.version} (Source zip)</td>
+ <td><a
href="[preferred]maven/plugins/${project.artifactId}-${project.version}-source-release.zip">maven/plugins/${project.artifactId}-${project.version}-source-release.zip</a></td>
+ <td><a
href="http://www.apache.org/dist/maven/plugins/${project.artifactId}-${project.version}-source-release.zip.md5";>maven/plugins/${project.artifactId}-${project.version}-source-release.zip.md5</a></td>
+ <td><a
href="http://www.apache.org/dist/maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc";>maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </subsection>
+
+ <subsection name="Previous Versions">
+
+ <p>Older non-recommended releases can be found on our <a
href="http://archive.apache.org/dist/maven/plugins/";>archive site</a>.</p>
+
+ </subsection>
+ </section>
+ </body>
+</document>
+
