incubator-kato-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spo...@apache.org
Subject svn commit: r800711 - in /incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx: chapters/API.xml chapters/appendix.xml spec.xml
Date Tue, 04 Aug 2009 09:20:46 GMT
Author: spoole
Date: Tue Aug  4 09:20:43 2009
New Revision: 800711

URL: http://svn.apache.org/viewvc?rev=800711&view=rev
Log:
more words in the edr

Modified:
    incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/API.xml
    incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/appendix.xml
    incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml

Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/API.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/API.xml?rev=800711&r1=800710&r2=800711&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/API.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/API.xml Tue Aug  4
09:20:43 2009
@@ -8,9 +8,9 @@
 	<sect1 xml:id="api.structure">
 		<title>Structure</title>
 
-		<para>JSR 326 consists of a series of packages that are separated
-			into four logical groups.
-    </para>
+		<para>JSR 326 consists of a series of Java packages listed below</para>
+        <xi:include href="../../../target/spec/chapters/sections/packagelist.xml" />
+    	<para>These packages are separated into into four logical groups.
 		<itemizedlist>
 			<listitem>
 				<para>Diagnostic Artifact creation</para>
@@ -25,41 +25,72 @@
 				<para>Process abstraction</para>
 			</listitem>
 		</itemizedlist>
+		</para>
 		<para>These logical separations are themselves grouped into two
 			further distinctions:
 			those available at creation time and those available at analysis time.
 		</para>
-		<xi:include href="../../../target/spec/chapters/sections/packagelist.xml" />
-		<para>The architecture that these packages represent can be
-			visualised as seen below</para>
 		<para>
-			In this diagram the white boxes represent the API, the yellow boxes
-			represent implementations that translate
-			from specific dump formats to the API structure and the red boxes
-			represent the various types of dump that can be
-			found.
+		This separation can be seen in the <xref linkend='summary.architecture.1'/>. In this
diagram the green layer represents the user application, 
+		the yellow layer represents the API and the orange layer represents implementations in
support of the API. The red shapes represent the different
+		types of diagnostic artifact that can be created.
+		<para>  
+		There is a vertical separation in this diagram which shows the two phases of the API. 

+		The left hand side shows two distinct JVM instances which is intended to indicate the capability
of the API 
+		to be used on multiple implementations in a standard way. 
+		The right hand side shows a single application  consuming multiple diagnostic artifacts.
  
+		</para>
+			<figure id="summary.architecture.1"><title>Summary Architecture</title>
+			<mediaobject>
+				<imageobject align="center">
+					<imagedata format="SVG" width="15cm" depth="15cm"
+						fileref="../figures/architecture.svg" />
+				</imageobject>
+			</mediaobject>
+			</figure>
+			
+		</para>
+		<sect2>
+			<title>Creation Time architecture</title>
+		<para>
+			In <xref linkend='architecture2'/> the green layer represents the application, the
yellow boxes
+			represent the API and the orange boxes represent implementations that translate
+			the dump creation request to the specific actions required to generate a diagnostic artifact.

+			
 			<para>The relationship between implementations and the discovery
 				mechanism is not shown in this diagram. See the section on the
 				discovery process for more information</para>
-			<figure><title>Summary Architecture</title>
-			<mediaobject id="architecture1">
+			<figure id="architecture2"><title>Creation Time Architecture</title>
+			<mediaobject >
 				<imageobject align="center">
 					<imagedata format="SVG" width="15cm" depth="15cm"
-						fileref="../figures/architecture.svg" />
+						fileref="../figures/annotatedanalysistime.svg" />
 				</imageobject>
 			</mediaobject>
 			</figure>
-			<para>Hello</para>
-			<figure><title>Analysis Time Architecture</title>
-			<mediaobject id="architecture2">
+			Hello
+		</para>
+		</sect2>
+		<sect2>
+			<title>Analysis Time architecture</title>
+		<para>
+			In <xref linkend='architecture3'/> the green layer represents  the API, the yellow
boxes
+			represent implementations that translate
+			from specific dump formats to the API structure and the red boxes
+			represent the various types of dump that can be found.
+			<para>The relationship between implementations and the discovery
+				mechanism is not shown in this diagram. See the section on the
+				discovery process for more information</para>
+			<figure id="architecture3"><title>Analysis Time Architecture</title>
+			<mediaobject >
 				<imageobject align="center">
 					<imagedata format="SVG" width="15cm" depth="15cm"
 						fileref="../figures/annotatedanalysistime.svg" />
 				</imageobject>
 			</mediaobject>
 			</figure>
-			<para>Hello2</para>
 		</para>
+		</sect2>
 	</sect1>
 	<sect1 xml:id="api.usage">
 		<title>Usage</title>

Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/appendix.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/appendix.xml?rev=800711&r1=800710&r2=800711&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/appendix.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/chapters/appendix.xml Tue Aug
 4 09:20:43 2009
@@ -12,7 +12,7 @@
 <sect2><title>Common Register Names</title>
 <table border="1">
 		<?dbfo	keep-together="auto"?> 
-	<title>IA32</title>
+	<title>IA32 Register Names</title>
     <tgroup cols='2' align='left' colsep='1' rowsep='1'>
     <thead><row><entry>Register</entry><entry>Type</entry></row></thead>
     <tbody>
@@ -31,7 +31,7 @@
     
     <table border="1">
     <?dbfo	keep-together="auto"?>
-    <title>IA64</title>
+    <title>IA64 Register Names</title>
     <tgroup cols='2' align='left' colsep='1' rowsep='1'>
     <thead><row><entry>Register</entry><entry>Type</entry></row></thead>
     <tbody>
@@ -58,7 +58,7 @@
     
     <table frame="border">
     <?dbfo	keep-together="auto"?>
-   <title>PowerPC 32</title>
+   <title>PowerPC 32 Register Names</title>
     <tgroup cols='2' align='left' colsep='1' rowsep='1'>
     <thead><row><entry>Register</entry><entry>Type</entry></row></thead>
     <tbody>
@@ -109,7 +109,7 @@
     
   <table frame="border">
   <?dbfo	keep-together="auto"?>
-     <title>PowerPC 64</title>
+     <title>PowerPC 64 Register Names</title>
     <tgroup cols='2' align='left' colsep='1' rowsep='1'>
     <thead><row><entry>Register</entry><entry>Type</entry></row></thead>
     <tbody>
@@ -157,7 +157,7 @@
 
     <table frame="border">
     <?dbfo	keep-together="auto"?>
- <title>Z/series 31</title>
+ <title>Z/series 31 Register Names</title>
     <tgroup cols='2' align='left' colsep='1' rowsep='1'>
     <thead><row><entry>Register</entry><entry>Type</entry></row></thead>
     <tbody>
@@ -183,7 +183,7 @@
     </tgroup>
     </table>
     <table frame="border">
- <title>Z/Series 64</title>
+ <title>Z/Series 64 Register Names</title>
     <tgroup cols='2' align='left' colsep='1' rowsep='1'>
     <thead><row><entry>Register</entry><entry>Type</entry></row></thead>
     <tbody>

Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml?rev=800711&r1=800710&r2=800711&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml Tue Aug  4 09:20:43
2009
@@ -9,17 +9,22 @@
 		<subtitle><para>First Early Draft Review</para><para>User manual
and specification</para></subtitle>
 		<pubdate><?dbtimestamp format="Y-m-d"?>
 		</pubdate>
-		<copyright>
-			<year><?dbtimestamp format="Y"?>
-			</year>
-			<holder>TBD</holder>
-		</copyright>
-		
-		
 		<legalnotice>
-			<para>
-				licence goes here
-            </para>
+<programlisting>
+Copyright 2009 IBM Corporation 
+			
+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. 
+</programlisting>
 		</legalnotice>
 		</info>
 		



Mime
View raw message