db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bpendle...@apache.org
Subject svn commit: r773758 - in /db/derby/docs/trunk/src: ref/ tuning/
Date Tue, 12 May 2009 01:52:24 GMT
Author: bpendleton
Date: Tue May 12 01:52:24 2009
New Revision: 773758

URL: http://svn.apache.org/viewvc?rev=773758&view=rev
Log:
DERBY-4065: Provide documentation for XPLAIN style statistics processing

This follow-on change removes some XREF tag which attempted to construct
cross-manual reference linkages. Although these tags appeared to work
properly in the "HTML pages" format, they had a rather odd behavior (the
page would change but the TOC would not), and furthermore they did not
work at all in the PDF and HTML single-page formats.

Therefore, this change backs out the XREF tags which contained the
cross-manual references, and replaces them with simple textual references
to topic titles in the appropriate manual. That at least gives the user
a pointer about where to look for additional information.


Modified:
    db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_mode.dita
    db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_schema.dita
    db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_mode.dita
    db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_schema.dita
    db/derby/docs/trunk/src/ref/rref_xplain_tables.dita
    db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita
    db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita
    db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita
    db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita
    db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita
    db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita
    db/derby/docs/trunk/src/tuning/ctun_xplain_tables.dita

Modified: db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_mode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_mode.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_mode.dita (original)
+++ db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_mode.dita Tue May 12 01:52:24 2009
@@ -29,10 +29,9 @@
 executed normally.
 </p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
 </section>
 <section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE()
RETURNS INTEGER</codeblock>

Modified: db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_schema.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_schema.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_schema.dita (original)
+++ db/derby/docs/trunk/src/ref/rref_syscs_get_xplain_schema.dita Tue May 12 01:52:24 2009
@@ -33,10 +33,9 @@
         the runtime statistics will be stored into the SYSXPLAIN_* database
         tables in that schema for later analysis.</p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
 </section>
 <section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA
() RETURNS VARCHAR</codeblock>

Modified: db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_mode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_mode.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_mode.dita (original)
+++ db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_mode.dita Tue May 12 01:52:24 2009
@@ -31,10 +31,9 @@
 <xref href="rref_syscs_set_xplain_schema.dita#rref_syscs_set_xplain_schema">SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</xref>
system
 procedure for more information.</p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
 </section>
 <section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_XPLAIN_MODE(IN
SMALLINT NOEXECUTE)</codeblock></section>

Modified: db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_schema.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_schema.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_schema.dita (original)
+++ db/derby/docs/trunk/src/ref/rref_syscs_set_xplain_schema.dita Tue May 12 01:52:24 2009
@@ -26,10 +26,9 @@
             statistics are written to the SYSXPLAIN_* database tables, so
             that you can analyze the statistics by running queries against
             the tables.
-           <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-          <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
         </p></section>
 <section><p>Turn xplain style on by calling this procedure with a non-empty
 argument. Turn xplain style off by calling the procedure with an empty

Modified: db/derby/docs/trunk/src/ref/rref_xplain_tables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rref_xplain_tables.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rref_xplain_tables.dita (original)
+++ db/derby/docs/trunk/src/ref/rref_xplain_tables.dita Tue May 12 01:52:24 2009
@@ -42,10 +42,9 @@
 the tables for you. You can capture multiple sets of data into the same
 tables, or you can specify a different schema each time.</p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
 </section>
 </refbody>

Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita Tue May 12 01:52:24 2009
@@ -49,10 +49,9 @@
             rows remain in the table until you delete them or drop the table.
                 </p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
                 <p>   <table
 pgwide="1" frame="all">

Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita Tue May 12 01:52:24 2009
@@ -52,10 +52,9 @@
             rows remain in the table until you delete them or drop the table.
                 </p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
                 <p>   <table
 pgwide="1" frame="all">

Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita Tue May 12 01:52:24 2009
@@ -48,10 +48,9 @@
             rows remain in the table until you delete them or drop the table.
                 </p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
                 <p>   <table
 pgwide="1" frame="all">

Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita Tue May 12 01:52:24 2009
@@ -42,10 +42,9 @@
                 <ph conref="../conrefs.dita#prod/productshortname"></ph>
                 has been configured appropriately. The
             rows remain in the table until you delete them or drop the table.
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p><p>   <table
 pgwide="1" frame="all">
 <tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>

Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita Tue May 12 01:52:24 2009
@@ -47,10 +47,9 @@
             rows remain in the table until you delete them or drop the table.
                 </p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
                 <p>   <table
 pgwide="1" frame="all">

Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita Tue May 12 01:52:24 2009
@@ -40,10 +40,9 @@
             rows remain in the table until you delete them or drop the table.
                 </p>
     <p>
-               <ph conref="../conrefs.dita#pub/cittuning"></ph> contains
-              <xref href="../tuning/ctun_xplain_style.dita#ctun_xplain_style">
-                 general information</xref> about how to use XPLAIN style
-                and the XPLAIN database tables.
+            See "Working with RunTimeStatistics" in the 
+            <ph conref="../conrefs.dita#pub/cittuning"></ph>
+            for additional information.
             </p>
                 <p>   <table
 pgwide="1" frame="all">

Modified: db/derby/docs/trunk/src/tuning/ctun_xplain_tables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctun_xplain_tables.dita?rev=773758&r1=773757&r2=773758&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctun_xplain_tables.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctun_xplain_tables.dita Tue May 12 01:52:24 2009
@@ -50,9 +50,8 @@
     <p>
         The XPLAIN style database tables are summarized here. For more
         information about the structure and content of each table,
-        please see the <ph conref="../conrefs.dita#pub/citref"></ph> for
-        <xref href="../ref/rref_xplain_tables.dita#rref_xplain_tables">
-            detailed table descriptions</xref>.
+        see "XPLAIN style tables" in
+        the <ph conref="../conrefs.dita#pub/citref"></ph>.
     </p>
     <dl>
         <dlentry>
@@ -61,10 +60,7 @@
             has had statistics captured. This row contains the text of the
             statement, as well as identifiers which can be used to join with
             the other tables to find more data about how this statement was
-            executed. The
-        <ph conref="../conrefs.dita#pub/citref"></ph> contains
-        <xref href="../ref/rrefsysxplain_statements.dita#rrefsysxplain_statements">
-            detailed table information</xref>
+            executed.
         </dd>
         </dlentry>
         <dlentry>
@@ -73,9 +69,6 @@
             was used during the execution of a particular explained statement.
             Most queries have one or several result sets; some complex queries
         can have many result sets.
-        The <ph conref="../conrefs.dita#pub/citref"></ph> contains
-        <xref href="../ref/rrefsysxplain_resultsets.dita#rrefsysxplain_resultsets">
-            detailed table information</xref>
         </dd>
         </dlentry>
         <dlentry>
@@ -84,9 +77,6 @@
             performed a scan of a table, index, or constraint. Using the
             information in this row, you can determine how much data needed
         to be examined by the scan.
-        The <ph conref="../conrefs.dita#pub/citref"></ph> contains
-        <xref href="../ref/rrefsysxplain_scan_props.dita#rrefsysxplain_scan_props">
-            detailed table information</xref>
         </dd>
         </dlentry>
         <dlentry>
@@ -94,9 +84,6 @@
         <dd>This table contains one row for each result set which
             performed a sort of data. Using the information in this row, you
         can determine how much data needed to be sorted.
-        The <ph conref="../conrefs.dita#pub/citref"></ph> contains
-        <xref href="../ref/rrefsysxplain_sort_props.dita#rrefsysxplain_sort_props">
-            detailed table information</xref>
         </dd>
         </dlentry>
         <dlentry>
@@ -105,9 +92,6 @@
             level. Timing information is optional, but if it is captured, the
             data in this table can be used to determine how much time each
         statement took.
-        The <ph conref="../conrefs.dita#pub/citref"></ph> contains
-        <xref href="../ref/rrefsysxplain_statement_timings.dita#rrefsysxplain_statement_timings">
-            detailed table information</xref>
         </dd>
         </dlentry>
         <dlentry>
@@ -116,9 +100,6 @@
             level. Timing information is optional, but if it is captured, the
             data in this table can be used to determine how much time each
         result set took.
-        The <ph conref="../conrefs.dita#pub/citref"></ph> contains
-        <xref href="../ref/rrefsysxplain_resultset_timings.dita#rrefsysxplain_resultset_timings">
-            detailed table information</xref>
         </dd>
         </dlentry>
     </dl>



Mime
View raw message