You are viewing a plain text version of this content. The canonical link for it is here.
Posted to kato-commits@incubator.apache.org by sp...@apache.org on 2009/07/12 00:15:52 UTC
svn commit: r793249 - in
/incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api:
pom.xml src/ant/ src/ant/spec.xml src/javadoc/ src/javadoc/logo.jpg
src/javadoc/overview.html
Author: spoole
Date: Sun Jul 12 00:15:52 2009
New Revision: 793249
URL: http://svn.apache.org/viewvc?rev=793249&view=rev
Log:
first pass of producing a pdf spec document
Added:
incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/ant/
incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/ant/spec.xml
incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/
incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/logo.jpg (with props)
incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/overview.html
Modified:
incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/pom.xml
Modified: incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/pom.xml
URL: http://svn.apache.org/viewvc/incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/pom.xml?rev=793249&r1=793248&r2=793249&view=diff
==============================================================================
--- incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/pom.xml (original)
+++ incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/pom.xml Sun Jul 12 00:15:52 2009
@@ -1,19 +1,64 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <parent>
- <artifactId>kato</artifactId>
- <groupId>org.apache.kato</groupId>
- <version>0.0.1-SNAPSHOT</version>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <groupId>org.apache.kato</groupId>
- <artifactId>kato.api</artifactId>
- <dependencies>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>3.8.1</version>
- <scope>test</scope>
- </dependency>
- </dependencies>
- <version>0.0.1-SNAPSHOT</version>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <artifactId>kato</artifactId>
+ <groupId>org.apache.kato</groupId>
+ <version>0.0.1-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.apache.kato</groupId>
+ <artifactId>kato.api</artifactId>
+ <dependencies>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+ <version>0.0.1-SNAPSHOT</version>
+ <name>JSR 326 API</name>
+ <description>Java classes that define the JSR 326 API</description>
+
+<reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
+ <docletArtifact>
+ <groupId>org.umlgraph</groupId>
+ <artifactId>doclet</artifactId>
+ <version>5.1</version>
+ </docletArtifact>
+ <additionalparam>-overview ${basedir}/src/javadoc/overview.html</additionalparam>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+<build>
+<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>compile</id>
+ <phase>compile</phase>
+ <configuration>
+ <tasks>
+ <ant antfile="spec.xml" dir="src/ant" target="pdf">
+ <property name="kato.aurigadoclet.jar" value="${kato.aurigadoclet.jar}"/>
+ </ant>
+ </tasks>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>
</project>
\ No newline at end of file
Added: incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/ant/spec.xml
URL: http://svn.apache.org/viewvc/incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/ant/spec.xml?rev=793249&view=auto
==============================================================================
--- incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/ant/spec.xml (added)
+++ incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/ant/spec.xml Sun Jul 12 00:15:52 2009
@@ -0,0 +1,39 @@
+<project>
+
+ <property name="src" location="../main/java"/>
+ <property name="out" location="../../target/site/spec/spec.pdf"/>
+ <property name="data" location="../javadoc"/>
+ <property name="cover" location="${data}/overview.html"/>
+ <property name="logo" location="${data}/logo.jpg"/>
+ <property name="target" location="../../target/site/spec"/>
+
+ <target name="pdf">
+
+ <available property="auriga.doclet.available" file="${kato.aurigadoclet.jar}"/>
+ <antcall target="create-spec"/>
+ <antcall target="no-spec"/>
+ </target>
+
+ <target name="create-spec" if="auriga.doclet.available">
+ <mkdir dir="${target}"/>
+ <copy todir="${target}" file="${logo}"/>
+
+ <echo>Building pdf using ${src}</echo>
+
+ <javadoc sourcepath="${src}" additionalparam="-format pdf -out ${out} -coverfile ${cover}">
+ <doclet name="com.aurigalogic.doclet.core.Doclet"
+ path="/home/spoole/aurigadoclet/bin/AurigaDoclet.jar">
+ </doclet>
+ <fileset dir="${src}"/>
+
+ </javadoc>
+
+ </target>
+ <target name="no-spec" unless="auriga.doclet.available">
+ <echo>
+ Unable to create pdf specification document
+ Set maven property kato.aurigadoclet.jar in local settings to point to jar containing
+ required doclet. (Visit http://aurigadoclet.sourceforge.net/) for more information
+ </echo>
+ </target>
+</project>
\ No newline at end of file
Added: incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/logo.jpg
URL: http://svn.apache.org/viewvc/incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/logo.jpg?rev=793249&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/logo.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/overview.html
URL: http://svn.apache.org/viewvc/incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/overview.html?rev=793249&view=auto
==============================================================================
--- incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/overview.html (added)
+++ incubator/kato/branches/experimental/maven_restructure/org.apache.kato/kato.api/src/javadoc/overview.html Sun Jul 12 00:15:52 2009
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<title>JSR 326 API Overview</title>
+</head>
+<body>
+<h2>JSR 326 - Post mortem JVM diagnostics API</h2>
+<h3>Early Draft Review 1</h3>
+<h3>2009</h3>
+<p>This is the initial draft of the specification for JSR 326. This
+is a "work in progress" document and is intended to provide a summation
+of information readily available. Further information can be found by
+visiting the <a href="http://jcp.org/en/jsr/detail?id=326">JSR 326
+community page</a> or by visiting the <a href="http://incubator.apache.org/projects/kato.html">Apache Kato Open Source
+project</a> <br />
+<br />
+JSR 326 is intended to be a Java API specification for standardising how
+and what can be retrieved from the contents of post-mortem artefacts -
+typically process and JVM dumps.</p>
+<p>Project Kato is intended to be the place where the Specification, Reference implementation (RI) and Technology Compatibility Kit (TCK) are openly created. The intention is that the Specification and RI will be developed in tight unison, guided by a user-story-focused approach to ensure that real-world problems drive the project from the beginning.
+</p><p>Unusually for new APIs, this project will endeavour to encompass the old and the new. A diagnostic solution that only works when users move to the latest release does little to improve diagnosability in the short term. This project will consume existing dump artefacts as well as possible while developing an API that can address the emerging trends in JVM and application directions. The most obvious of these trends are the exploitation of very large heaps, alternative languages and, paradoxically for Java, the increased use of native memory through vehicles such as NIO.</p>
+<p><img alt="logo" src="logo.jpg"/></p>
+</body>
+</html>