Author: bimargulies
Date: Sat Feb 25 17:14:53 2012
New Revision: 1293652
URL: http://svn.apache.org/viewvc?rev=1293652&view=rev
Log:
Start to try for doc and a lifecycle.
Added:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/maven/
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml
(with props)
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt
(with props)
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/usage.apt.vm
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml (with
props)
Added:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml?rev=1293652&view=auto
==============================================================================
---
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml
(added)
+++
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml
Sat Feb 25 17:14:53 2012
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<component-set>
+ <components>
+ <component>
+ <role>org.apache.maven.lifecycle.Lifecycle</role>
+ <implementation>org.apache.maven.lifecycle.Lifecycle</implementation>
+ <role-hint>svnpubsub</role-hint>
+ <configuration>
+ <id>svnpubsub</id>
+ <phases>
+ <phase>pre-site</phase>
+ <phase>site</phase>
+ <phase>post-site</phase>
+ <phase>site-deploy</phase>
+ </phases>
+ <default-phases>
+ <pre-site>
+ org.apache.maven.plugins:asf-svnpubsub-plugin:1.0-SNAPSHOT:prepare
+ </pre-site>
+ <site>
+ org.apache.maven.plugins:maven-site-plugin:3.0:site
+ </site>
+ <post-site>
+ org.apache.maven.plugins:maven-site-plugin:3.0:stage
+ </post-site>
+ <site-deploy>
+ org.apache.maven.plugins:asf-svnpubsub-plugin:1.0-SNAPSHOT:prepare
+ </site-deploy>
+ </default-phases>
+ </configuration>
+ </component>
+ </components>
+</component-set>
Propchange:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/main/resources/META-INF/plexus/components.xml
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt?rev=1293652&view=auto
==============================================================================
--- maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt
(added)
+++ maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt Sat
Feb 25 17:14:53 2012
@@ -0,0 +1,63 @@
+ ------
+ Introduction
+ ------
+ Benson Margulies
+ ------
+ 2012-02-25
+ ------
+
+~~ 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
+
+ASF svnpubsub Plugin
+
+ The asf-svnpubsub-plugin is a utility plugin to allow Apache
+ projects to publish Maven websites via the ASF svnpubsub
+ system.
+
+ The plugin provides two goals: <<prepare>> and <<publish>>.
+
+ The prepare goal checks out the contents of a directory from
+ Subversion into (by default) target/svnpubsub-checkout. It
+ then lists the files known to Subversion and stores them
+ in (by default) target/svnpubsub-inventory.js. This provides
+ the point of reference for an eventual Subversion checkin.
+
+ After running the prepare goal, the POM must run site:site and
+ site:stage, with the <stagingDirectory> set to
+ target/svnpubsub-checkout.
+
+ Finally, the <<publish>> goal compares the output of site:stage
+ with the inventory from the <<prepare>> goal, and issues
+ appropriate SCM commands to add and deleted, followed by a
+ checkin.
+
+ The <svnpubsub.dryRun> parameter to the <<publish>> goal avoids all
+ SCM operations, and simply logs out the added, deleted,
+ and changed files.
+
+ The <<svnpubsub.skipCheckin>> parameter omits the final checkin.
+ This allows you to visit target/svnpubsub-checkout, and validate
+ its contents before submitting to Subversion.
+
+
+
+
+
\ No newline at end of file
Propchange:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/usage.apt.vm?rev=1293652&view=auto
==============================================================================
--- maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/usage.apt.vm
(added)
+++ maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/apt/usage.apt.vm
Sat Feb 25 17:14:53 2012
@@ -0,0 +1,142 @@
+ ------
+ Usage
+ ------
+ Benson Margulies
+ ------
+ 2012-02-25
+ ------
+
+~~ 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 asf-svnpubsub-plugin submits modified sites to subversion for
+ publication with svnpubsub. Here's how to set this up in your POM:
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </reporting>
+ ...
+</project>
++-----+
+
+ When you execute <<<mvn site>>>, the javadocs will be generated and included
in the generated site. A link to the javadocs
+ will be added in the Project Reports menu.
+
+* Generate Standalone Javadocs
+
+ To generate standalone javadocs for the project, you could add the Javadoc
Plugin in the \<build\> section of your pom
+ (if no configuration defined, the plugin uses default values):
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++-----+
+
+ And execute any of the following commands:
+
++-----+
+mvn javadoc:javadoc
+mvn javadoc:jar
+mvn javadoc:aggregate
+mvn javadoc:aggregate-jar
+mvn javadoc:test-javadoc
+mvn javadoc:test-jar
+mvn javadoc:test-aggregate
+mvn javadoc:test-aggregate-jar
++-----+
+
+ For all <<<jar>>> goals, the javadocs are first generated and then packaged
into a jar file.
+
+* Javadoc Configuration
+
+ The Javadoc Plugin supports a large number of configuration parameters. Each
configuration parameter turns into
+ a tag name.
+
+ Please refer to the {{{./javadoc-mojo.html}Javadoc Plugin Documentation}} for
a listing of these parameters. Most
+ of these parameters are passed directly to the Javadoc tool itself.
+
+ <<IMPORTANT NOTE>>: configuring the Javadoc plugin in the \<reporting/\> or
\<build/\> elements in the pom have
+ <<NOT>> the same behavior as described in the
+
{{{http://maven.apache.org/guides/mini/guide-configuring-plugins.html#Using_the_reporting_Tag_VS_build_Tag}Guide
to Configuring Plug-ins}}.
+
+ For instance, if you have the following snippet:
+
++-----+
+<project>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <show>private</show>
+ <nohelp>true</nohelp>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+
<stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
+ <show>public</show>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+ </build>
++-----+
Added: maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml?rev=1293652&view=auto
==============================================================================
--- maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml (added)
+++ maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml Sat Feb
25 17:14:53 2012
@@ -0,0 +1,35 @@
+<?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>
+ <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"/>
+ <item name="Release Notes" href="jira-report.html"/>
+ </menu>
+ <menu name="Examples">
+ </menu>
+ </body>
+</project>
Propchange: maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/plugins/asf-svnpubsub-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:mime-type = text/plain
