incubator-kato-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From monte...@apache.org
Subject svn commit: r890324 - in /incubator/kato/trunk/org.apache.kato: kato.api.vm/pom.xml kato.distro/pom.xml kato.distro/src/main/assembly/bindist.xml kato.distro/src/main/readme/README
Date Mon, 14 Dec 2009 13:47:59 GMT
Author: monteith
Date: Mon Dec 14 13:47:58 2009
New Revision: 890324

URL: http://svn.apache.org/viewvc?rev=890324&view=rev
Log:
Add vm.api javadoc to package. Small doc change.

Modified:
    incubator/kato/trunk/org.apache.kato/kato.api.vm/pom.xml
    incubator/kato/trunk/org.apache.kato/kato.distro/pom.xml
    incubator/kato/trunk/org.apache.kato/kato.distro/src/main/assembly/bindist.xml
    incubator/kato/trunk/org.apache.kato/kato.distro/src/main/readme/README

Modified: incubator/kato/trunk/org.apache.kato/kato.api.vm/pom.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api.vm/pom.xml?rev=890324&r1=890323&r2=890324&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api.vm/pom.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.api.vm/pom.xml Mon Dec 14 13:47:58 2009
@@ -29,4 +29,22 @@
   <name>VM side Kato API </name>
   <version>M1-incubating</version>
   <description>VM side Kato API for configuring and triggering dumps</description>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+             <executions>
+                <execution>
+                        <phase>package</phase>
+                        <goals>
+                               <goal>jar</goal>
+                        </goals>
+                </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
 </project>

Modified: incubator/kato/trunk/org.apache.kato/kato.distro/pom.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.distro/pom.xml?rev=890324&r1=890323&r2=890324&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.distro/pom.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.distro/pom.xml Mon Dec 14 13:47:58 2009
@@ -43,6 +43,12 @@
 
 <!-- Includes API JavaDoc -->
  	 <dependency>
+  		<artifactId>kato.api.vm</artifactId>
+  		<groupId>org.apache.kato</groupId>
+  		<version>M1-incubating</version>
+        <classifier>javadoc</classifier>
+  	</dependency>
+ 	 <dependency>
   		<artifactId>kato.api</artifactId>
   		<groupId>org.apache.kato</groupId>
   		<version>M1-incubating</version>

Modified: incubator/kato/trunk/org.apache.kato/kato.distro/src/main/assembly/bindist.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.distro/src/main/assembly/bindist.xml?rev=890324&r1=890323&r2=890324&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.distro/src/main/assembly/bindist.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.distro/src/main/assembly/bindist.xml Mon Dec
14 13:47:58 2009
@@ -92,6 +92,7 @@
       </includes>
       <excludes>
       	<exclude>org.apache.kato:kato.api:jar:javadoc:*</exclude>
+      	<exclude>org.apache.kato:kato.api.vm:jar:javadoc:*</exclude>
       </excludes>
       <unpack>false</unpack>
       <scope>compile</scope>
@@ -104,6 +105,7 @@
       <outputDirectory>docs</outputDirectory>
       <includes>
       	<include>org.apache.kato:kato.api:jar:javadoc:*</include>
+      	<include>org.apache.kato:kato.api.vm:jar:javadoc:*</include>
       </includes>
       <unpack>false</unpack>
     </dependencySet>

Modified: incubator/kato/trunk/org.apache.kato/kato.distro/src/main/readme/README
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.distro/src/main/readme/README?rev=890324&r1=890323&r2=890324&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.distro/src/main/readme/README (original)
+++ incubator/kato/trunk/org.apache.kato/kato.distro/src/main/readme/README Mon Dec 14 13:47:58
2009
@@ -78,7 +78,14 @@
 
 . if local variable information is not available (JIT frames, no local variable info in class),
   the variables won't appear in the debugger. Heap objects may be missing as a result.
-. 
+
+Dump API
+========
+
+The Dump API allows dumps to be initiated by Java programs while they are running.
+The API is documented in the Javadoc, available in:
+    docs/kato.api.vm-${project.version}-javadoc.jar
+
 
 The API
 =======
@@ -123,7 +130,8 @@
 so it is important that the jar files containing them are put onto the JVM's
 classpath in the form they are provided. 
 
-The hprof implementation requires the following two libraries: 
+The hprof implementation requires the three following libraries: 
+    lib/kato.common-${project.version}.jar
     lib/kato.hprof.api-${project.version}.jar
     lib/kato.hprof.reader-${project.version}.jar
 



Mime
View raw message