You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2013/10/24 19:10:24 UTC
svn commit: r1535443 - in /db/derby/docs/trunk/src: tools/ tuning/
Author: chaase3
Date: Thu Oct 24 17:10:24 2013
New Revision: 1535443
URL: http://svn.apache.org/r1535443
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 8 Tools Guide and 5 Tuning Derby topics.
Patch: DERBY-6379-toolstuning.diff
Modified:
db/derby/docs/trunk/src/tools/ctoolsij34525.dita
db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita
db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita
db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita
db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita
db/derby/docs/trunk/src/tools/rtoolslicense.dita
db/derby/docs/trunk/src/tools/rtoolsoptdbmetadata.dita
db/derby/docs/trunk/src/tools/rtoolsoptforeignviews.dita
db/derby/docs/trunk/src/tuning/ctundepth1002853.dita
db/derby/docs/trunk/src/tuning/ctunperf98197.dita
db/derby/docs/trunk/src/tuning/ctuntransform25857.dita
db/derby/docs/trunk/src/tuning/rtunlicense.dita
db/derby/docs/trunk/src/tuning/rtuntransform582.dita
Modified: db/derby/docs/trunk/src/tools/ctoolsij34525.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsij34525.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsij34525.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsij34525.dita Thu Oct 24 17:10:24 2013
@@ -19,13 +19,14 @@ limitations under the License.
-->
<concept id="ctoolsij34525" xml:lang="en-us">
<title>Using ij</title>
-<shortdesc>ij is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-interactive JDBC scripting tool. It is a simple utility for running scripts
-or interactive queries against a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
+<p>ij is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
+interactive JDBC scripting tool. It is a simple utility for running scripts
+or interactive queries against a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</p>
<p>ij is a Java application, which you start from a command window such as
an MS-DOS Command Window or the UNIX shell. ij provides several non-SQL commands
for ease in accessing a variety of JDBC features for testing.</p>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools11318.dita Thu Oct 24 17:10:24 2013
@@ -18,16 +18,16 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="ctoolsijtools11318">
<title>Tools and localization</title>
-<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
-provide support for common localization features such as localized message
-files and GUI, locale-appropriate formatting of data, codesets, unicode
-identifiers and data, and database locales.</shortdesc>
<prolog><metadata>
<keywords>
</keywords>
</metadata>
</prolog>
<conbody>
+<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+provide support for common localization features such as localized message
+files and GUI, locale-appropriate formatting of data, codesets, unicode
+identifiers and data, and database locales.</p>
<p>For general information about localizing
<ph conref="../conrefs.dita#prod/productshortname"></ph> systems, see the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools20118.dita Thu Oct 24 17:10:24 2013
@@ -19,19 +19,20 @@ limitations under the License.
-->
<concept id="ctoolsijtools20118" xml:lang="en-us">
<title>JDBC connection basics</title>
-<shortdesc>Most of the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
-are JDBC applications. A JDBC application is one that uses the classes in
-the <i>java.sql</i> package to interact with a DBMS.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
+<p>Most of the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+are JDBC applications. A JDBC application is one that uses the classes in
+the <i>java.sql</i> package to interact with a DBMS.</p>
<p>When you work with JDBC applications, you need to know about several concepts.
The most basic is the <i>connection</i>. A <i>JDBC connection</i> is the object
through which commands are sent to the <ph conref="../conrefs.dita#prod/productshortname"></ph> engine
-and responses are returned to the program. Establishing a <i>connection</i> to
+and responses are returned to the program. Establishing a connection to
a specific database is done by specifying a appropriate database <i>URL</i>.
The following sections provide background information to help in understanding
-the Derby database connection URL.</p>
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> database connection
+URL.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools26429.dita Thu Oct 24 17:10:24 2013
@@ -19,15 +19,15 @@ limitations under the License.
-->
<concept id="ctoolsijtools26429" xml:lang="en-us">
<title>What are the Derby tools and utilities?</title>
-<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph>
-tools and utilities are a set of routines supplied with
-<ph conref="../conrefs.dita#prod/productshortname"></ph> that are typically used
-to create, inspect, and update a
-<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Tools<indexterm>how to use</indexterm></indexterm></keywords>
</metadata></prolog>
<conbody>
+<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools and
+utilities are a set of routines supplied with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> that are typically used
+to create, inspect, and update a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</p>
<p>For more complete information on developing a system using <ph conref="../conrefs.dita#prod/productshortname"></ph>,
see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.
</p>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools30948.dita Thu Oct 24 17:10:24 2013
@@ -19,13 +19,12 @@ limitations under the License.
-->
<concept id="ctoolsijtools30948" xml:lang="en-us">
<title>Overview</title>
-<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> is a
-database management system (DBMS), accessed by applications through the JDBC
-API.</shortdesc>
<prolog><metadata>
<keywords></keywords>
</metadata></prolog>
<conbody>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> is a database
+management system (DBMS), accessed by applications through the JDBC API.</p>
<p>Included with the product are some standalone Java tools and utilities
that make it easier to use and develop applications for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
<p>These tools and utilities include:</p>
Modified: db/derby/docs/trunk/src/tools/rtoolslicense.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolslicense.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolslicense.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolslicense.dita Thu Oct 24 17:10:24 2013
@@ -20,7 +20,6 @@ limitations under the License.
<!--##### DO NOT CHANGE ANYTHING ABOVE THIS LINE #####-->
<reference id="rtoolslicense" xml:lang="en-us">
<title>License</title>
-<shortdesc></shortdesc>
<prolog><metadata>
<keywords><indexterm>Apache<indexterm>license</indexterm></indexterm></keywords>
</metadata></prolog>
Modified: db/derby/docs/trunk/src/tools/rtoolsoptdbmetadata.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsoptdbmetadata.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsoptdbmetadata.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsoptdbmetadata.dita Thu Oct 24 17:10:24 2013
@@ -19,9 +19,6 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rtoolsoptdbmetadata" xml:lang="en-us">
<title>Using the databaseMetaData optional tool</title>
-<shortdesc>The <codeph>databaseMetaData</codeph> optional tool creates functions
-and table functions corresponding to most of the methods in the
-<i>java.sql.DatabaseMetaData</i> interface.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>optional tools<indexterm>databaseMetaData</indexterm></indexterm>
@@ -31,6 +28,9 @@ and table functions corresponding to mos
</metadata></prolog>
<refbody>
<section>
+<p>The <codeph>databaseMetaData</codeph> optional tool creates functions
+and table functions corresponding to most of the methods in the
+<i>java.sql.DatabaseMetaData</i> interface.</p>
<p>Before you run the <codeph>databaseMetaData</codeph> optional tool, make sure
that your classpath contains the
<ph conref="../conrefs.dita#prod/productshortname"></ph> jar files, including
Modified: db/derby/docs/trunk/src/tools/rtoolsoptforeignviews.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsoptforeignviews.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsoptforeignviews.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsoptforeignviews.dita Thu Oct 24 17:10:24 2013
@@ -19,9 +19,6 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rtoolsoptforeignviews" xml:lang="en-us">
<title>Using the foreignViews optional tool</title>
-<shortdesc>The <codeph>foreignViews</codeph> optional tool creates schemas,
-table functions, and convenience views for all user tables in a foreign
-database. This can be useful for bulk-importing foreign data.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>optional tools<indexterm>foreignViews</indexterm></indexterm>
@@ -31,6 +28,9 @@ database. This can be useful for bulk-im
</metadata></prolog>
<refbody>
<section>
+<p>The <codeph>foreignViews</codeph> optional tool creates schemas,
+table functions, and convenience views for all user tables in a foreign
+database. This can be useful for bulk-importing foreign data.</p>
<p>Before you run the <codeph>foreignViews</codeph> optional tool, make sure
that your classpath contains the
<ph conref="../conrefs.dita#prod/productshortname"></ph> jar files, including
Modified: db/derby/docs/trunk/src/tuning/ctundepth1002853.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctundepth1002853.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctundepth1002853.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctundepth1002853.dita Thu Oct 24 17:10:24 2013
@@ -20,12 +20,12 @@ limitations under the License.
-->
<concept id="ctundepth1002853" xml:lang="en-us">
<title>Create useful indexes</title>
-<shortdesc>Indexes are useful when a query contains a WHERE clause.</shortdesc>
<prolog><metadata>
<keywords><indexterm>indexes<indexterm>guidance, creating</indexterm></indexterm>
</keywords>
</metadata></prolog>
<conbody>
+<p>Indexes are useful when a query contains a WHERE clause.</p>
<p>Without a WHERE clause, <ph conref="../conrefs.dita#prod/productshortname"></ph> is <i>supposed</i> to
return all the data in the table, and so a table scan is the correct (if not
desirable) behavior. (More about that in <xref href="ctundepth36205.dita#ctundepth36205"></xref>.)</p>
Modified: db/derby/docs/trunk/src/tuning/ctunperf98197.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunperf98197.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunperf98197.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunperf98197.dita Thu Oct 24 17:10:24 2013
@@ -20,14 +20,14 @@ limitations under the License.
-->
<concept id="ctunperf98197" xml:lang="en-us">
<title>Use the appropriate getXXX and setXXX methods for the type</title>
-<shortdesc>For performance reasons, use the recommended <i>getXXX</i> method
-when retrieving values, and use the recommended <i>setXXX</i> method when
-setting values for parameters.</shortdesc>
<prolog><metadata>
<keywords><indexterm>methods<indexterm>getxxx</indexterm></indexterm><indexterm>methods<indexterm>setxxx</indexterm></indexterm>
</keywords>
</metadata></prolog>
<conbody>
+<p>For performance reasons, use the recommended <i>getXXX</i> method
+when retrieving values, and use the recommended <i>setXXX</i> method when
+setting values for parameters.</p>
<p>JDBC is permissive. It lets you use <i>java.sql.ResultSet.getFloat</i> to
retrieve an int, <i>java.sql.ResultSet.getObject</i> to retrieve any type,
and so on. (<i>java.sql.ResultSet </i>and <i>java.sql.CallableStatement</i> provide <i>getXXX</i> methods,
Modified: db/derby/docs/trunk/src/tuning/ctuntransform25857.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctuntransform25857.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctuntransform25857.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctuntransform25857.dita Thu Oct 24 17:10:24 2013
@@ -20,13 +20,13 @@ limitations under the License.
-->
<concept id="ctuntransform25857" xml:lang="en-us">
<title>Materialization</title>
-<shortdesc><term>Materialization</term> means that a subquery is evaluated
-only once. There are several types of subqueries that can be materialized.</shortdesc>
<prolog><metadata>
<keywords><indexterm>subqueries<indexterm>materialization</indexterm></indexterm>
<indexterm><indexterm>materialization</indexterm>subqueries</indexterm></keywords>
</metadata></prolog>
<conbody>
+<p><term>Materialization</term> means that a subquery is evaluated
+only once. Several types of subqueries can be materialized.</p>
<section><title>Expression subqueries that are not correlated</title><p>A
subquery can be materialized if it is a noncorrelated expression subquery.
A correlated subquery is one that references columns in the outer query, and
Modified: db/derby/docs/trunk/src/tuning/rtunlicense.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/rtunlicense.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/rtunlicense.dita (original)
+++ db/derby/docs/trunk/src/tuning/rtunlicense.dita Thu Oct 24 17:10:24 2013
@@ -20,7 +20,6 @@ limitations under the License.
<!--##### DO NOT CHANGE ANYTHING ABOVE THIS LINE #####-->
<reference id="rtunlicense" xml:lang="en-us">
<title>License</title>
-<shortdesc></shortdesc>
<prolog><metadata>
<keywords><indexterm>Apache<indexterm>license</indexterm></indexterm></keywords>
</metadata></prolog>
Modified: db/derby/docs/trunk/src/tuning/rtuntransform582.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/rtuntransform582.dita?rev=1535443&r1=1535442&r2=1535443&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/rtuntransform582.dita (original)
+++ db/derby/docs/trunk/src/tuning/rtuntransform582.dita Thu Oct 24 17:10:24 2013
@@ -20,7 +20,6 @@ limitations under the License.
-->
<reference id="rtuntransform582" xml:lang="en-us">
<title>Simple IN predicate transformations</title>
-<shortdesc></shortdesc>
<prolog><metadata>
<keywords><indexterm>IN transformations</indexterm><indexterm>Internal transformation
of statements<indexterm>IN predicates</indexterm></indexterm><indexterm>IN