svn commit: r1814359 - in /maven/plugins/trunk/maven-jdeprscan-plugin/src/site: ./ apt/ apt/index.apt.vm apt/usage.apt.vm resources/ resources/download.cgi site.xml

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r1814359 - in /maven/plugins/trunk/maven-jdeprscan-plugin/src/site: ./ apt/ apt/index.apt.vm apt/usage.apt.vm resources/ resources/download.cgi site.xml

rfscholte
Author: rfscholte
Date: Sun Nov  5 15:20:02 2017
New Revision: 1814359

URL: http://svn.apache.org/viewvc?rev=1814359&view=rev
Log:
Add documentation

Added:
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/index.apt.vm
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/usage.apt.vm
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/resources/
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/resources/download.cgi
    maven/plugins/trunk/maven-jdeprscan-plugin/src/site/site.xml

Added: maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/index.apt.vm?rev=1814359&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/index.apt.vm (added)
+++ maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/index.apt.vm Sun Nov  5 15:20:02 2017
@@ -0,0 +1,76 @@
+  ------
+  Introduction
+  ------
+  Robert Scholte
+  ------
+  2017-11-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 Maven JDeprScan plugin is used to scan class files for uses of deprecated API elements.
+    
+  NOTE: This is an alpha release which means everything can change until we reach the first
+  milestone release.
+
+* Goals Overview
+
+  The JDeprScan Plugin has four goals:
+
+  * {{{./jdeprscan-mojo.html}jdeprscan:jdeprscan}} scans the main sources for deprecated APIs.
+
+  * {{{./test-jdeprscan-mojo.html}jdeprscan:test-jdeprscan}} scans the test sources for deprecated APIs.
+
+  * {{{./list-mojo.html}jdeprscan:list}} Prints the set of deprecated APIs.
+    No scanning is done, so no directory, jar, or class arguments should be provided.
+
+  * {{{./help-mojo.html}jdeprscan:help}} displays help information on maven-jdeprscan-plugin.
+
+  []
+
+* Usage
+
+  General instructions on how to use the JDeprScan Plugin can be found on the {{{./usage.html}usage page}}. Some more
+  specific use cases are described in the examples given below.
+
+  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}}.
+
+* Examples
+
+  To provide you with better understanding on some usages of the Maven JDeprScan Plugin,
+  you can take a look into the following examples:
+
+  TODO: Add examples.
+
+  []

Added: maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/usage.apt.vm?rev=1814359&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/usage.apt.vm (added)
+++ maven/plugins/trunk/maven-jdeprscan-plugin/src/site/apt/usage.apt.vm Sun Nov  5 15:20:02 2017
@@ -0,0 +1,69 @@
+  ------
+  Usage
+  ------
+  Robert Scholte
+  ------
+  2017-11-05
+
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed 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
+
+* Introduction
+
+  The Maven JDeprScan plugin is used to scan class files for uses of deprecated API elements.
+  
+* Configuration of the Maven JDeprScan Plugin
+
+  To use the Maven JDeprScan Plugin you have to configure it as an <<<extensions>>> which means
+  the configuration in your pom file has to look like this:
+  
++-----
+<project>
+  [...]
+  <build>
+    [...]
+    <plugins>
+      [...]
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jdeprscan-plugin</artifactId>
+        <version>${project.version}</version>
+        <configuration>
+          <!-- configuration elements goes here -->
+        </configuration>
+      </plugin>
+   [...]
+</project>
++-----
+
+  The configuration element contains the configuration for the plugin
+  {{{https://maven.apache.org/guides/mini/guide-configuring-plugins.html}like any other Maven plugin}}.
+  The different elements which can be configured for this plugin can identified by the
+  {{{./plugin-info.html}goals documentation}}.
+
+* Requirements
+
+  Based on the foundation of the plugin it is required to have JDK 9 installed. This means
+  either you have it configured via <<JAVA_HOME>> which means to run the whole
+  Maven build with JDK 9 or via <<Toolchains>>.
+
+  How to configure Maven related to Toolchains can be read in the
+  {{{https://maven.apache.org/guides/mini/guide-using-toolchains.html}Toolchains documentation}}.
+

Added: maven/plugins/trunk/maven-jdeprscan-plugin/src/site/resources/download.cgi
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeprscan-plugin/src/site/resources/download.cgi?rev=1814359&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeprscan-plugin/src/site/resources/download.cgi (added)
+++ maven/plugins/trunk/maven-jdeprscan-plugin/src/site/resources/download.cgi Sun Nov  5 15:20:02 2017
@@ -0,0 +1,22 @@
+#!/bin/sh
+#
+# 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.
+#
+# Just call the standard mirrors.cgi script. It will use download.html
+# as the input template.
+exec /www/www.apache.org/dyn/mirrors/mirrors.cgi $*
\ No newline at end of file

Added: maven/plugins/trunk/maven-jdeprscan-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jdeprscan-plugin/src/site/site.xml?rev=1814359&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jdeprscan-plugin/src/site/site.xml (added)
+++ maven/plugins/trunk/maven-jdeprscan-plugin/src/site/site.xml Sun Nov  5 15:20:02 2017
@@ -0,0 +1,40 @@
+<?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"
+>
+  <custom>
+    <fluidoSkin>
+      <profile>pre-release</profile>
+    </fluidoSkin>
+  </custom>
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html" />
+      <item name="Goals" href="plugin-info.html" />
+      <item name="Usage" href="usage.html" />
+      <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
+      <item name="License" href="http://www.apache.org/licenses/" />
+      <item name="Download" href="download.html" />
+    </menu>
+  </body>
+</project>