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 2014/06/20 22:03:20 UTC
svn commit: r1604269 [1/2] - /db/derby/docs/trunk/src/ref/
Author: chaase3
Date: Fri Jun 20 20:03:18 2014
New Revision: 1604269
URL: http://svn.apache.org/r1604269
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 65 Reference Manual topics.
Patch: DERBY-6379-ref-props.diff
Modified:
db/derby/docs/trunk/src/ref/crefproper22250.dita
db/derby/docs/trunk/src/ref/crefproper51399.dita
db/derby/docs/trunk/src/ref/crefproperdynstat.dita
db/derby/docs/trunk/src/ref/rrefproper10607.dita
db/derby/docs/trunk/src/ref/rrefproper13217.dita
db/derby/docs/trunk/src/ref/rrefproper13766.dita
db/derby/docs/trunk/src/ref/rrefproper18151.dita
db/derby/docs/trunk/src/ref/rrefproper23835.dita
db/derby/docs/trunk/src/ref/rrefproper24390.dita
db/derby/docs/trunk/src/ref/rrefproper24846.dita
db/derby/docs/trunk/src/ref/rrefproper25025.dita
db/derby/docs/trunk/src/ref/rrefproper25581.dita
db/derby/docs/trunk/src/ref/rrefproper26978.dita
db/derby/docs/trunk/src/ref/rrefproper26985.dita
db/derby/docs/trunk/src/ref/rrefproper27355.dita
db/derby/docs/trunk/src/ref/rrefproper27467.dita
db/derby/docs/trunk/src/ref/rrefproper27529.dita
db/derby/docs/trunk/src/ref/rrefproper28026.dita
db/derby/docs/trunk/src/ref/rrefproper32066.dita
db/derby/docs/trunk/src/ref/rrefproper32213.dita
db/derby/docs/trunk/src/ref/rrefproper33027.dita
db/derby/docs/trunk/src/ref/rrefproper34037.dita
db/derby/docs/trunk/src/ref/rrefproper35028.dita
db/derby/docs/trunk/src/ref/rrefproper37341.dita
db/derby/docs/trunk/src/ref/rrefproper39325.dita
db/derby/docs/trunk/src/ref/rrefproper40346.dita
db/derby/docs/trunk/src/ref/rrefproper40688.dita
db/derby/docs/trunk/src/ref/rrefproper43414.dita
db/derby/docs/trunk/src/ref/rrefproper43517.dita
db/derby/docs/trunk/src/ref/rrefproper46141.dita
db/derby/docs/trunk/src/ref/rrefproper81359.dita
db/derby/docs/trunk/src/ref/rrefproper81405.dita
db/derby/docs/trunk/src/ref/rrefproper98166.dita
db/derby/docs/trunk/src/ref/rrefproperauthdn.dita
db/derby/docs/trunk/src/ref/rrefproperauthpw.dita
db/derby/docs/trunk/src/ref/rrefproperbootall.dita
db/derby/docs/trunk/src/ref/rrefproperbuiltinalgorithm.dita
db/derby/docs/trunk/src/ref/rrefproperclasspath.dita
db/derby/docs/trunk/src/ref/rrefproperdatadictversion.dita
db/derby/docs/trunk/src/ref/rrefproperdefaultfileperms.dita
db/derby/docs/trunk/src/ref/rrefproperdurability.dita
db/derby/docs/trunk/src/ref/rrefproperextdiagsevlevel.dita
db/derby/docs/trunk/src/ref/rrefproperindexstatsauto.dita
db/derby/docs/trunk/src/ref/rrefproperindexstatslog.dita
db/derby/docs/trunk/src/ref/rrefproperindexstatstrace.dita
db/derby/docs/trunk/src/ref/rrefproperiterations.dita
db/derby/docs/trunk/src/ref/rrefproperlogboottrace.dita
db/derby/docs/trunk/src/ref/rrefproperlogbuffersize.dita
db/derby/docs/trunk/src/ref/rrefpropermaxlogshippinginterval.dita
db/derby/docs/trunk/src/ref/rrefproperminlogshippinginterval.dita
db/derby/docs/trunk/src/ref/rrefpropernoautoboot.dita
db/derby/docs/trunk/src/ref/rrefproperpasswordmillis.dita
db/derby/docs/trunk/src/ref/rrefproperpasswordthreshold.dita
db/derby/docs/trunk/src/ref/rrefproperpreallocator.dita
db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita
db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita
db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita
db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita
db/derby/docs/trunk/src/ref/rrefproperrowlocking.dita
db/derby/docs/trunk/src/ref/rrefpropersaltlength.dita
db/derby/docs/trunk/src/ref/rrefpropersqlauth.dita
db/derby/docs/trunk/src/ref/rrefproperstatementcachesize.dita
db/derby/docs/trunk/src/ref/rrefproperstormin.dita
db/derby/docs/trunk/src/ref/rrefproperverbose.dita
db/derby/docs/trunk/src/ref/rrefproperxatrantimeout.dita
Modified: db/derby/docs/trunk/src/ref/crefproper22250.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproper22250.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefproper22250.dita (original)
+++ db/derby/docs/trunk/src/ref/crefproper22250.dita Fri Jun 20 20:03:18 2014
@@ -20,14 +20,15 @@ limitations under the License.
-->
<concept id="crefproper22250" xml:lang="en-us">
<title>Derby properties</title>
+<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph>
+properties are used for configuring the system and database, as well as for
+diagnostics such as logging statements, and monitoring and tracing
+locks.</shortdesc>
<prolog><metadata>
<keywords><indexterm><indexterm>properties</indexterm>overview, Derby</indexterm>
</keywords>
</metadata></prolog>
<conbody>
-<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> properties are
-used for configuring the system and database, as well as for diagnostics such as
-logging statements, and monitoring and tracing locks.</p>
<p>The table later in this topic lists all the core
<ph conref="../conrefs.dita#prod/productshortname"></ph> properties.</p>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> also supports a
Modified: db/derby/docs/trunk/src/ref/crefproper51399.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproper51399.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefproper51399.dita (original)
+++ db/derby/docs/trunk/src/ref/crefproper51399.dita Fri Jun 20 20:03:18 2014
@@ -19,10 +19,13 @@ limitations under the License.
-->
<concept id="crefproper51399" xml:lang="en-us">
<title>Scope of <ph conref="../conrefs.dita#prod/productshortname"></ph> properties</title>
+<shortdesc>A property in
+<ph conref="../conrefs.dita#prod/productshortname"></ph> can have system-wide
+scope, database-wide scope, or both.</shortdesc>
<prolog></prolog>
<conbody>
-<p>A property in <ph conref="../conrefs.dita#prod/productshortname"></ph> belongs
-to one or more of these scopes:<ul id="i1008301">
+<p>
+<ul>
<li id="rrefproper41229"><i>system-wide</i> <p>System-wide properties apply
to an entire system, including all its databases and tables if applicable.</p>
<ul compact="yes">
Modified: db/derby/docs/trunk/src/ref/crefproperdynstat.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproperdynstat.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefproperdynstat.dita (original)
+++ db/derby/docs/trunk/src/ref/crefproperdynstat.dita Fri Jun 20 20:03:18 2014
@@ -18,6 +18,9 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="crefproperdynstat">
<title>Dynamic and static properties</title>
+<shortdesc>A property in
+<ph conref="../conrefs.dita#prod/productshortname"></ph> can be dynamic or
+static.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>Static properties</indexterm>
Modified: db/derby/docs/trunk/src/ref/rrefproper10607.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper10607.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper10607.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper10607.dita Fri Jun 20 20:03:18 2014
@@ -18,26 +18,27 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper10607">
<title>derby.locks.deadlockTimeout</title>
+<shortdesc>The <i>derby.locks.deadlockTimeout</i> property determines the number
+of seconds after which <ph conref="../conrefs.dita#prod/productshortname"></ph>
+checks whether a transaction waiting to obtain a lock is involved in a
+deadlock.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.locks.deadlockTimeout</indexterm><indexterm>Deadlocks<indexterm>timeout property</indexterm></indexterm>
+<keywords><indexterm>derby.locks.deadlockTimeout property</indexterm>
+<indexterm>Deadlocks<indexterm>timeout property</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Determines the number of seconds after which
-<ph conref="../conrefs.dita#prod/productshortname"></ph> checks whether a
-transaction waiting to obtain a lock is involved in a deadlock. If a deadlock
-has occurred, and <ph conref="../conrefs.dita#prod/productshortname"></ph>
-chooses the transaction as a deadlock victim,
-<ph conref="../conrefs.dita#prod/productshortname"></ph> aborts the transaction.
-The transaction receives an <i>SQLException</i> of <i>SQLState</i> 40001. If the
-transaction is not chosen as the victim, it continues to wait for a lock if
-<i><xref href="rrefproper46141.dita#rrefproper46141">derby.locks.waitTimeout</xref></i>
-is set to a higher value than the value of <i>derby.locks.deadlockTimeout</i>.
-</p>
+<section>
+<p>If a deadlock has occurred, and
+<ph conref="../conrefs.dita#prod/productshortname"></ph> chooses the transaction
+as a deadlock victim, <ph conref="../conrefs.dita#prod/productshortname"></ph>
+aborts the transaction. The transaction receives an <i>SQLException</i> of
+<i>SQLState</i> 40001. If the transaction is not chosen as the victim, it
+continues to wait for a lock if
+<i><xref href="rrefproper46141.dita">derby.locks.waitTimeout</xref></i> is set
+to a higher value than the value of <i>derby.locks.deadlockTimeout</i>.</p>
<p>If this property is set to a higher value than
-<i>derby.locks.waitTimeout</i>, no deadlock checking occurs. See
-<i><xref href="rrefproper46141.dita#rrefproper46141">derby.locks.waitTimeout</xref>.</i></p>
+<i>derby.locks.waitTimeout</i>, no deadlock checking occurs.</p>
<p>For more information about deadlock checking, see "Deadlocks" in the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
</section>
@@ -52,6 +53,5 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper13217.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper13217.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper13217.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper13217.dita Fri Jun 20 20:03:18 2014
@@ -18,22 +18,23 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper13217">
<title>derby.infolog.append</title>
+<shortdesc>The <i>derby.infolog.append</i> property specifies whether to append
+to or overwrite (delete and recreate) the <i>derby.log</i> file when the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> engine is
+started.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.infolog.append</indexterm>
+<keywords><indexterm>derby.infolog.append property</indexterm>
<indexterm>Information log<indexterm>overwriting</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies whether to append to or overwrite (delete and recreate) the
-<i>derby.log</i> file when the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> engine is started. The
-<i>derby.log</i> file is used to record errors and other information. This
-information can help you debug problems within a system.</p>
+<section>
+<p>The <i>derby.log</i> file is used to record errors and other information.
+This information can help you debug problems within a system.</p>
<p>You can set this property even if the file does not yet exist;
<ph conref="../conrefs.dita#prod/productshortname"></ph> creates the file.</p>
<p>See
-<i><xref href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> for
+<i><xref href="rrefproperrollingfile.dita"/></i> for
information on how this property works if the <i>derby.stream.error.style</i>
property is set.</p>
</section>
Modified: db/derby/docs/trunk/src/ref/rrefproper13766.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper13766.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper13766.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper13766.dita Fri Jun 20 20:03:18 2014
@@ -20,14 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefproper13766" xml:lang="en-us">
<title>derby.authentication.provider</title>
+<shortdesc>The <i>derby.authentication.provider</i> property specifies the
+authentication provider for
+<ph conref="../conrefs.dita#prod/productshortname"></ph> user
+authentication.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.authentication.provider</indexterm>
-<indexterm>Authentication provider<indexterm>specifying</indexterm></indexterm></keywords>
+<keywords><indexterm>derby.authentication.provider property</indexterm>
+<indexterm>Authentication provider<indexterm>specifying</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>Specifies the authentication provider
-for <ph conref="../conrefs.dita#prod/productshortname"></ph> user
-authentication.</p>
+<section>
<p>Legal values include:</p>
<ul>
<li>NATIVE:<i>credentialsDB</i>
@@ -43,8 +46,7 @@ directive by specifying their own value
</li>
<li>NATIVE:<i>credentialsDB</i>:LOCAL
<p>NATIVE authentication using <i>credentialsDB</i> for system-wide operations,
-but using an individual database's
-<xref href="rrefsistabssysusers.dita#rrefsistabssysusers"></xref> to
+but using an individual database's <xref href="rrefsistabssysusers.dita"/> to
authenticate connections to that database. This value must be set by using
system-wide JVM properties or by using the <i>derby.properties</i> file; it
cannot be set in the database by using the SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY
@@ -59,43 +61,42 @@ authentication" and "Configuring LDAP au
<ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
<p>To enable any <ph conref="../conrefs.dita#prod/productshortname"></ph> user
authentication setting other than NATIVE, you must set the
-<i><xref href="rrefproper27467.dita#rrefproper27467">derby.connection.requireAuthentication</xref></i>
+<i><xref href="rrefproper27467.dita">derby.connection.requireAuthentication</xref></i>
property to true. If you specify NATIVE authentication,
<ph conref="../conrefs.dita#prod/productshortname"></ph> behaves as if the
<i>derby.connection.requireAuthentication</i> and
-<i><xref href="rrefpropersqlauth.dita#rrefpropersqlauth">derby.database.sqlAuthorization</xref></i>
+<i><xref href="rrefpropersqlauth.dita">derby.database.sqlAuthorization</xref></i>
properties were also set.</p>
<p>When using NATIVE authentication, you can also set the following related
properties:</p>
<ul>
-<li><i><xref href="rrefproperpasswordmillis.dita#rrefproperpasswordmillis"></xref></i></li>
-<li><i><xref href="rrefproperpasswordthreshold.dita#rrefproperpasswordthreshold"></xref></i></li>
+<li><i><xref href="rrefproperpasswordmillis.dita"/></i></li>
+<li><i><xref href="rrefproperpasswordthreshold.dita"/></i></li>
</ul>
<p>When using NATIVE authentication, the database owner calls the
-<codeph><xref href="rrefnativecreateuserproc.dita#rrefnativecreateuserproc">SYSCS_UTIL.SYSCS_CREATE_USER</xref></codeph>
+<codeph><xref href="rrefnativecreateuserproc.dita">SYSCS_UTIL.SYSCS_CREATE_USER</xref></codeph>
system procedure to create users, and can also call the following additional user
management procedures:</p>
<ul>
-<li><codeph><xref href="rrefnativedropuserproc.dita#rrefnativedropuserproc">SYSCS_UTIL.SYSCS_DROP_USER</xref></codeph></li>
-<li><codeph><xref href="rrefnativeresetpasswordproc.dita#rrefnativeresetpasswordproc">SYSCS_UTIL.SYSCS_RESET_PASSWORD</xref></codeph></li>
+<li><codeph><xref href="rrefnativedropuserproc.dita">SYSCS_UTIL.SYSCS_DROP_USER</xref></codeph></li>
+<li><codeph><xref href="rrefnativeresetpasswordproc.dita">SYSCS_UTIL.SYSCS_RESET_PASSWORD</xref></codeph></li>
</ul>
<p>When using NATIVE authentication, any user can call the
-<codeph><xref href="rrefnativemodifypasswordproc.dita#rrefnativemodifypasswordproc">SYSCS_UTIL.SYSCS_MODIFY_PASSWORD</xref></codeph>
+<codeph><xref href="rrefnativemodifypasswordproc.dita">SYSCS_UTIL.SYSCS_MODIFY_PASSWORD</xref></codeph>
system procedure to change that user's password.</p>
-
<p>For more information about user authentication, see "Configuring user
authentication" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
<p>When using an external authentication service provider (LDAP), you must also
set:</p>
<ul>
-<li><i><xref href="rrefproper25581.dita#rrefproper25581">derby.authentication.server</xref></i></li>
+<li><i><xref href="rrefproper25581.dita">derby.authentication.server</xref></i></li>
</ul>
<p>When using LDAP, you can set other LDAP-specific properties. See also:</p>
<ul>
-<li><i><xref href="rrefproperauthdn.dita#rrefproperauthdn"></xref></i></li>
-<li><i><xref href="rrefproperauthpw.dita#rrefproperauthpw"></xref></i></li>
-<li><i><xref href="rrefproper37341.dita#rrefproper37341"></xref></i></li>
-<li><i><xref href="rrefproper26978.dita#rrefproper26978"></xref></i></li>
+<li><i><xref href="rrefproperauthdn.dita"/></i></li>
+<li><i><xref href="rrefproperauthpw.dita"/></i></li>
+<li><i><xref href="rrefproper37341.dita"/></i></li>
+<li><i><xref href="rrefproper26978.dita"/></i></li>
</ul>
<p>Alternatively, you can write your own class to provide a different external
authentication service. This class must implement the public interface
Modified: db/derby/docs/trunk/src/ref/rrefproper18151.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper18151.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper18151.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper18151.dita Fri Jun 20 20:03:18 2014
@@ -18,19 +18,20 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper18151">
<title>derby.stream.error.file</title>
+<shortdesc>The <i>derby.stream.error.file</i> property specifies the name of the
+file to which the error log is written.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.stream.error.file</indexterm>
+<keywords><indexterm>derby.stream.error.file property</indexterm>
<indexterm>Error log<indexterm>specifying file name</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies name of the file to which the error log is written. If the file
-name is relative, it is taken as relative to the system directory.</p>
+<section>
+<p>If the file name is relative, it is taken as relative to the system
+directory.</p>
<p>If this property is set, the
-<i><xref href="rrefproper35028.dita#rrefproper35028">derby.stream.error.method</xref></i>
-and
-<i><xref href="rrefproper33027.dita#rrefproper33027">derby.stream.error.field</xref></i>
+<i><xref href="rrefproper35028.dita">derby.stream.error.method</xref></i> and
+<i><xref href="rrefproper33027.dita">derby.stream.error.field</xref></i>
properties are ignored.</p>
<p>If you specify this property, the property setting appears in the error
log.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproper23835.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper23835.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper23835.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper23835.dita Fri Jun 20 20:03:18 2014
@@ -18,21 +18,22 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper23835">
<title>derby.locks.deadlockTrace</title>
+<shortdesc>The <i>derby.locks.deadlockTrace</i> property causes a detailed list
+of locks at the time of a deadlock or a timeout to be written to the error log
+(typically the file <i>derby.log</i>).</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.locks.deadlockTrace</indexterm>
+<keywords><indexterm>derby.locks.deadlockTrace property</indexterm>
<indexterm>Deadlocks<indexterm>tracing</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Causes a detailed list of locks at the time of a deadlock or a timeout
-to be written to the error log (typically the file <i>derby.log</i>). For a
-deadlock, <ph conref="../conrefs.dita#prod/productshortname"></ph> describes the
-cycle of locks which caused the deadlock. For a timeout,
+<section>
+<p>For a deadlock, <ph conref="../conrefs.dita#prod/productshortname"></ph>
+describes the cycle of locks which caused the deadlock. For a timeout,
<ph conref="../conrefs.dita#prod/productshortname"></ph> prints the entire lock
list at the time of the timeout. This property is meaningful only if the
-<i><xref href="rrefproper98166.dita#rrefproper98166">derby.locks.monitor</xref></i>
-property is set to <i>true</i>.</p>
+<i><xref href="rrefproper98166.dita">derby.locks.monitor</xref></i> property is
+set to <i>true</i>.</p>
<note>This level of debugging is intrusive: it can alter
the timing of the application, reduce performance severely, and produce a
large error log file. It should be used with care.</note>
@@ -49,6 +50,5 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper24390.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper24390.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper24390.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper24390.dita Fri Jun 20 20:03:18 2014
@@ -18,16 +18,17 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper24390">
<title>derby.database.propertiesOnly</title>
+<shortdesc>The <i>derby.database.propertiesOnly</i> property, when set to true,
+ensures that database-wide properties cannot be overridden by system-wide
+properties.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.database.propertiesOnly</indexterm>
+<keywords><indexterm>derby.database.propertiesOnly property</indexterm>
<indexterm>Database-wide properties<indexterm>protecting against
overrides</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>When set to true, this property ensures that database-wide properties cannot
-be overridden by system-wide properties.</p>
+<section>
<p>When this property is set to false, or not set, database-wide properties can
be overridden by system-wide properties (see "Precedence of properties" in the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>).</p>
@@ -46,5 +47,5 @@ environment in which it is booted.</p>
<p>This property is dynamic; if you change it while
<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
takes effect immediately. For information about dynamic changes to properties,
-see <xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper24846.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper24846.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper24846.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper24846.dita Fri Jun 20 20:03:18 2014
@@ -18,17 +18,17 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper24846">
<title>derby.database.defaultConnectionMode</title>
+<shortdesc>The <i>derby.database.defaultConnectionMode</i> property, one of the
+user authorization properties, defines the default connection mode for users of
+the database or system for which this property is set.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.database. defaultConnectionMode</indexterm>
+<keywords><indexterm>derby.database.defaultConnectionMode property</indexterm>
<indexterm>User authorization<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>One of the user authorization properties.</p>
-<p>Defines the default connection mode for users of the database or system
-for which this property is set. The possible values (which are case-insensitive)
-are:</p>
+<section>
+<p>The possible values (which are case-insensitive) are:</p>
<ul>
<li><i>noAccess</i>
<p>Disallows connections.</p></li>
@@ -41,8 +41,10 @@ are:</p>
<note>It is possible to configure a database so that it cannot be changed
(or even accessed) using this property. If you set this property to
<i>noAccess</i> or <i>readOnlyAccess</i>, be sure to allow at least one user
-full access. See <i><xref href="rrefproper25025.dita#rrefproper25025"/></i> and
-<i><xref href="rrefproper39325.dita#rrefproper39325"/>.</i></note>
+full access. See
+<i><xref href="rrefproper25025.dita">derby.database.fullAccessUsers</xref></i>
+and
+<i><xref href="rrefproper39325.dita">derby.database.readOnlyAccessUsers</xref></i>.</note>
<p>For more information about user authorization, see "Configuring user
authorization" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
</section>
@@ -64,5 +66,5 @@ derby.database.defaultConnectionMode=noA
<section><title>Dynamic or static</title>
<p>Dynamic. Current connections are not affected, but all future connections
are affected. For information about dynamic changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+<xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper25025.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper25025.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper25025.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper25025.dita Fri Jun 20 20:03:18 2014
@@ -18,21 +18,23 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper25025">
<title>derby.database.fullAccessUsers</title>
+<shortdesc>The <i>derby.database.fullAccessUsers</i> property, one of the user
+authorization properties, specifies a list of users to which full (read-write)
+access to a database is granted.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.database.fullAccessUsers</indexterm>
+<keywords><indexterm>derby.database.fullAccessUsers property</indexterm>
<indexterm>User authorization<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>One of the user authorization properties. Specifies a list of users to
-which full (read-write) access to a database is granted. The list consists
-of user names separated by commas. Do not put spaces after commas.</p>
+<section>
+<p>The list consists of user names separated by commas. Do not put spaces after
+the commas.</p>
<p>When set as a system property, specifies a list of users for which full
access to all the databases in the system is granted.</p>
-<p>See also <i><xref href="rrefproper39325.dita#rrefproper39325"/>.</i></p>
<p>A malformed list of user names raises an exception. Do not specify a user
-both with this property and in <i>derby.database.readOnlyAccessUsers</i>.</p>
+both with this property and in
+<i><xref href="rrefproper39325.dita">derby.database.readOnlyAccessUsers</xref></i>.</p>
<note>User names, called authorization identifiers,
follow the rules of <i>SQL92Identifiers</i> and can be delimited.
Specifying a user name that does not follow these rules raises an
@@ -56,5 +58,5 @@ derby.database.fullAccessUsers=dba,fred,
<section><title>Dynamic or static</title>
<p>Dynamic. Current connections are not affected, but all future connections
are affected. For information about dynamic changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+<xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper25581.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper25581.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper25581.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper25581.dita Fri Jun 20 20:03:18 2014
@@ -20,18 +20,20 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefproper25581" xml:lang="en-us">
<title>derby.authentication.server</title>
+<shortdesc>The <i>derby.authentication.server</i> property specifies the
+location of the external directory service that provides user authentication for
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> system as defined
+with the <i>derby.authentication.provider</i> property.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.authentication.server</indexterm>
+<keywords><indexterm>derby.authentication.server property</indexterm>
<indexterm>LDAP<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies the location of the external directory service that provides user
-authentication for the <ph conref="../conrefs.dita#prod/productshortname"></ph>
-system as defined with
-<i><xref href="rrefproper13766.dita#rrefproper13766"/></i>. For LDAP, specify
-the host name and port number.</p>
+<section>
+<p>For LDAP, specify the host name and port number. See
+<i><xref href="rrefproper13766.dita">derby.authentication.provider</xref></i>
+for more information.</p>
<p>The server must be known on the network.</p>
<p>For more information about external user authentication, see "Configuring
LDAP authentication" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproper26978.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper26978.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper26978.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper26978.dita Fri Jun 20 20:03:18 2014
@@ -18,15 +18,17 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper26978">
<title>derby.authentication.ldap.searchBase</title>
+<shortdesc>The <i>derby.authentication.ldap.searchBase</i> property specifies
+the root DN of the point in your hierarchy from which to begin a guest or
+anonymous search for the user's DN.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.authentication.ldap.searchbase</indexterm>
+<keywords><indexterm>derby.authentication.ldap.searchbase property</indexterm>
<indexterm>LDAP<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies the root DN of the point in your hierarchy from which to begin
-a guest or anonymous search for the user's DN. For example:</p>
+<section>
+<p>For example:</p>
<codeblock><b>ou=people,o=example.com</b></codeblock>
<p>When using Netscape Directory Server, set this property to the root DN,
the special entry to which access control does not apply.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproper26985.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper26985.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper26985.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper26985.dita Fri Jun 20 20:03:18 2014
@@ -18,17 +18,19 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper26985">
<title>derby.stream.error.logSeverityLevel</title>
+<shortdesc>The <i>derby.stream.error.logSeverityLevel</i> property specifies
+which errors are logged to the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> error log (typically
+the <i>derby.log</i> file).</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.stream.error.logSeverityLevel</indexterm>
+<keywords><indexterm>derby.stream.error.logSeverityLevel property</indexterm>
<indexterm>Error log<indexterm>configuring severity of errors
that appear in</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies which errors are logged to the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> error log (typically
-the <i>derby.log</i> file). In test environments, use the setting
+<section>
+<p>In test environments, use the setting
<i>derby.stream.error.logSeverityLevel=0</i> so that all problems are
reported.</p>
<p>Any error raised in a
Modified: db/derby/docs/trunk/src/ref/rrefproper27355.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper27355.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper27355.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper27355.dita Fri Jun 20 20:03:18 2014
@@ -20,26 +20,30 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefproper27355" xml:lang="en-us">
<title>derby.user.UserName</title>
+<shortdesc>The <i>derby.user.UserName</i> property caches user DNs locally when
+<i>derby.authentication.provider</i> is set to <codeph>LDAP</codeph> and
+<i>derby.authentication.ldap.searchFilter</i> is set to
+<codeph>derby.user</codeph>.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.user</indexterm>
+<keywords><indexterm>derby.user property</indexterm>
<indexterm>Users<indexterm>creating</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Caches user DNs locally when <i>derby.authentication.provider</i> is set to
-<i>LDAP</i> and
-<i><xref href="rrefproper37341.dita#rrefproper37341">derby.authentication.ldap.searchFilter</xref></i>
-is set to <i>derby.user</i>.</p>
+<section>
+<p>See
+<i><xref href="rrefproper13766.dita">derby.authentication.provider</xref></i>
+and
+<i><xref href="rrefproper37341.dita">derby.authentication.ldap.searchFilter</xref></i>
+for more information.</p>
<p>When you provide a user DN with this property,
<ph conref="../conrefs.dita#prod/productshortname"></ph> is able to avoid an
LDAP search for that user's DN before authenticating. For those users without
DNs defined with this property,
<ph conref="../conrefs.dita#prod/productshortname"></ph> performs a search using
the default value of <i>derby.authentication.ldap.searchFilter</i>.</p>
-<p>User names are <xref
-href="crefsqlj34834.dita#crefsqlj34834">SQL92Identifier</xref>s and can be
-delimited.</p>
+<p>User names are <i><xref href="crefsqlj34834.dita">SQL92Identifier</xref></i>s
+and can be delimited.</p>
</section>
<refsyn><title>Syntax</title>
<codeblock><b>derby.user.<i>UserName=userDN</i></b></codeblock>
@@ -61,7 +65,7 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+<xref href="crefproperdynstat.dita"/>.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper27467.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper27467.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper27467.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper27467.dita Fri Jun 20 20:03:18 2014
@@ -18,21 +18,22 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper27467">
<title>derby.connection.requireAuthentication</title>
+<shortdesc>The <i>derby.connection.requireAuthentication</i> property turns on
+user authentication for
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.connection. requireAuthentication</indexterm>
+<keywords><indexterm>derby.connection.requireAuthentication property</indexterm>
<indexterm>Authentication<indexterm>turning on</indexterm></indexterm>
<indexterm>User authentication<indexterm>turning on</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Turns on user authentication for
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<section>
<p>When user authentication is turned on, a connection request must provide
a valid user name and password.</p>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> uses the type of
user authentication specified with the
-<i><xref href="rrefproper13766.dita#rrefproper13766">derby.authentication.provider</xref></i>
+<i><xref href="rrefproper13766.dita">derby.authentication.provider</xref></i>
property.</p>
<p>If the <i>derby.authentication.provider</i> property specifies
NATIVE authentication, <ph conref="../conrefs.dita#prod/productshortname"></ph>
Modified: db/derby/docs/trunk/src/ref/rrefproper27529.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper27529.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper27529.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper27529.dita Fri Jun 20 20:03:18 2014
@@ -18,27 +18,28 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper27529">
<title>derby.storage.initialPages</title>
+<shortdesc>The <i>derby.storage.initialPages</i> property creates a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> table or index with a
+number of pages already pre-allocated.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.storage.initialPages</indexterm>
+<keywords><indexterm>derby.storage.initialPages property</indexterm>
<indexterm>Database pages<indexterm>preallocating</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
+<section>
<p>The on-disk size of a
<ph conref="../conrefs.dita#prod/productshortname"></ph> table grows by one page
at a time until eight pages of user data (or nine pages of total disk use; one
is used for overhead) have been allocated. Then it will grow by eight pages at a
time if possible.</p>
-<p>A <ph conref="../conrefs.dita#prod/productshortname"></ph> table or index can
-be created with a number of pages already pre-allocated. To do so, specify the
-property prior to the CREATE TABLE or CREATE INDEX statement.</p>
-<p>Define the number of user pages the table or index is to be created with.
-The purpose of this property is to preallocate a table or index of reasonable
-size if the user expects that a large amount of data will be inserted into
-the table or index. A table or index that has the pre-allocated pages will
-enjoy a small performance improvement over a table or index that has no
-pre-allocated pages when the data are loaded.</p>
+<p>To pre-allocate pages, specify the property prior to the CREATE TABLE or
+CREATE INDEX statement. The property value defines the number of user pages the
+table or index is to be created with. The purpose of this property is to
+preallocate a table or index of reasonable size if the user expects that a large
+amount of data will be inserted into the table or index. A table or index that
+has the pre-allocated pages will enjoy a small performance improvement over a
+table or index that has no pre-allocated pages when the data are loaded.</p>
<p>The total desired size of the table or index should be the following number
of bytes:</p>
<codeblock><b>(1 + derby.storage.initialPages) * derby.storage.pageSize</b></codeblock>
Modified: db/derby/docs/trunk/src/ref/rrefproper28026.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper28026.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper28026.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper28026.dita Fri Jun 20 20:03:18 2014
@@ -18,21 +18,22 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper28026">
<title>derby.storage.pageReservedSpace</title>
+<shortdesc>The <i>derby.storage.pageReservedSpace</i> property defines the
+percentage of space reserved for updates on an on-disk database page for tables
+only (not indexes) and indicates the percentage of space to keep free on a page
+when inserting.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.storage.pageReservedSpace</indexterm>
+<keywords><indexterm>derby.storage.pageReservedSpace property</indexterm>
<indexterm>Reserving space on a page</indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Defines the percentage of space reserved for updates on an on-disk database
-page for tables only (not indexes); indicates the percentage of space to keep
-free on a page when inserting. Leaving reserved space on a page can minimize
-row overflow (and the associated performance hit) during updates. Once a page
-has been filled up to the reserved-space threshold, no new rows are allowed
-on the page. This reserved space is used only for rows that increase in size
-when updated, not for new inserts. Set this property prior to issuing the
-CREATE TABLE statement.</p>
+<section>
+<p>Leaving reserved space on a page can minimize row overflow (and the
+associated performance hit) during updates. Once a page has been filled up to
+the reserved-space threshold, no new rows are allowed on the page. This reserved
+space is used only for rows that increase in size when updated, not for new
+inserts. Set this property prior to issuing the CREATE TABLE statement.</p>
<p>Regardless of the value of <i>derby.storage.pageReservedSpace</i>, an empty
page always accepts at least one row.</p>
</section>
@@ -60,5 +61,5 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
<p>This property is dynamic: if you change it while
<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
takes effect immediately. For information about dynamic changes to properties,
-see <xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper32066.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper32066.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper32066.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper32066.dita Fri Jun 20 20:03:18 2014
@@ -18,15 +18,17 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper32066">
<title>derby.system.home</title>
+<shortdesc>The <i>derby.system.home</i> property specifies the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system directory, which
+is the directory that contains subdirectories holding databases that you create
+and the text file <i>derby.properties</i>.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.system.home</indexterm>
+<keywords><indexterm>derby.system.home property</indexterm>
+<indexterm>system directory<indexterm>specifying</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies the <ph conref="../conrefs.dita#prod/productshortname"></ph> system
-directory, which is the directory that contains subdirectories holding databases
-that you create and the text file <i>derby.properties</i>.</p>
+<section>
<p>If the system directory that you specify with <i>derby.system.home</i> does
not exist at startup, <ph conref="../conrefs.dita#prod/productshortname"></ph>
creates the directory automatically.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproper32213.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper32213.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper32213.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper32213.dita Fri Jun 20 20:03:18 2014
@@ -18,13 +18,12 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper32213">
<title><ph conref="../conrefs.dita#prod/productshortname"></ph> property reference</title>
-<prolog>
-</prolog>
-<refbody><section>
-<p>This section provides reference information on
+<shortdesc>This section provides reference information on
<ph conref="../conrefs.dita#prod/productshortname"></ph> properties. For
information on using these properties, see "Working with
<ph conref="../conrefs.dita#prod/productshortname"></ph> properties" in the
-<ph conref="../conrefs.dita#pub/citdevelop"></ph>.
-</p></section>
-</refbody></reference>
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</shortdesc>
+<prolog></prolog>
+<refbody>
+</refbody>
+</reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper33027.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper33027.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper33027.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper33027.dita Fri Jun 20 20:03:18 2014
@@ -19,16 +19,17 @@ limitations under the License.
-->
<reference id="rrefproper33027" xml:lang="en-us">
<title>derby.stream.error.field</title>
+<shortdesc>The <i>derby.stream.error.field</i> property specifies a static field
+that references a stream to which the error log is written.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.stream.error.field</indexterm>
+<keywords><indexterm>derby.stream.error.field property</indexterm>
<indexterm>Error log<indexterm>redirecting to a stream</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies a static field that references a stream to which the error log is
-written. The field is specified using the fully qualified name of the class,
-then a dot (.) and then the field name. The field must be public and static. Its
-type can be either <i>java.io.OutputStream</i> or <i>java.io.Writer</i>. </p>
+<section>
+<p>The field is specified using the fully qualified name of the class, then a
+dot (.), and then the field name. The field must be public and static. Its type
+can be either <i>java.io.OutputStream</i> or <i>java.io.Writer</i>. </p>
<p>The field is accessed once at
<ph conref="../conrefs.dita#prod/productshortname"></ph> boot time, and the
value is used until <ph conref="../conrefs.dita#prod/productshortname"></ph> is
Modified: db/derby/docs/trunk/src/ref/rrefproper34037.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper34037.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper34037.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper34037.dita Fri Jun 20 20:03:18 2014
@@ -18,21 +18,22 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper34037">
<title>derby.storage.tempDirectory</title>
+<shortdesc>The <i>derby.storage.tempDirectory</i> property defines the location
+on disk for temporary file space needed by
+<ph conref="../conrefs.dita#prod/productshortname"></ph> for performing large
+sorts and deferred deletes and updates.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.storage.tempDirectory</indexterm>
+<keywords><indexterm>derby.storage.tempDirectory property</indexterm>
<indexterm>tmp directory<indexterm>setting location for</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Defines the location on disk for temporary file space needed by
-<ph conref="../conrefs.dita#prod/productshortname"></ph> for performing large
-sorts and deferred deletes and updates. (Temporary files are automatically
-deleted after use, and are removed when the database restarts after a crash.)
-The temporary directory named by this property will be created if it does not
-exist, but will not be deleted when the system shuts down. The path name
-specified by this property must have file separators that are appropriate to the
-current operating system.</p>
+<section>
+<p>Temporary files are automatically deleted after use and are removed when the
+database restarts after a crash. The temporary directory named by this property
+will be created if it does not exist, but will not be deleted when the system
+shuts down. The path name specified by this property must have file separators
+that are appropriate to the current operating system.</p>
<p>This property allows databases located on read-only media to write temporary
files to a writable location. If this property is not set, databases located
on read-only media might get an error like the following:</p>
Modified: db/derby/docs/trunk/src/ref/rrefproper35028.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper35028.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper35028.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper35028.dita Fri Jun 20 20:03:18 2014
@@ -19,16 +19,17 @@ limitations under the License.
-->
<reference id="rrefproper35028" xml:lang="en-us">
<title>derby.stream.error.method</title>
+<shortdesc>The <i>derby.stream.error.method</i> property specifies a static
+method that returns a stream to which the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> error log is
+written.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.stream.error.method</indexterm>
+<keywords><indexterm>derby.stream.error.method property</indexterm>
<indexterm>Error log<indexterm>redirecting to a stream</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies a static method that returns a stream to which the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> error log is
-written.</p>
+<section>
<p>Specify the method using the fully qualified name of the class, then a dot
(.) and then the method name. The method must be public and static. Its return
type can be either <i>java.io.OutputStream </i>or <i>java.io.Writer</i>.
@@ -42,7 +43,8 @@ null, the error stream defaults to the s
not exist or is inaccessible, the error stream defaults to the system error
stream (<i>java.lang.System.err</i>).</p>
<p>If the value of this property is set, the property
-<i>derby.stream.error.field</i> is ignored.</p>
+<i><xref href="rrefproper33027.dita">derby.stream.error.field</xref></i> is
+ignored.</p>
<p>If you specify this property, the property setting appears in the error
log.</p>
</section>
Modified: db/derby/docs/trunk/src/ref/rrefproper37341.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper37341.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper37341.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper37341.dita Fri Jun 20 20:03:18 2014
@@ -18,24 +18,23 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper37341">
<title>derby.authentication.ldap.searchFilter</title>
+<shortdesc>The <i>derby.authentication.ldap.searchFilter</i> property specifies
+the search filter to use to determine what constitutes a user (and other search
+predicate) for <ph conref="../conrefs.dita#prod/productshortname"></ph> searches
+for a full DN during user authentication.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.authentication.ldap.searchfilter</indexterm>
+<keywords><indexterm>derby.authentication.ldap.searchfilter property</indexterm>
<indexterm>LDAP<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies the search filter to use to determine what constitutes a user
-(and other search predicate) for
-<ph conref="../conrefs.dita#prod/productshortname"></ph> searches for a full DN
-during user authentication.</p>
+<section>
<p>If you set this property to <i>derby.user</i>,
<ph conref="../conrefs.dita#prod/productshortname"></ph> looks for cached full
DNs for users that you have defined with the
-<i><xref href="rrefproper27355.dita#rrefproper27355">derby.user.UserName</xref></i>
-property. For other users,
-<ph conref="../conrefs.dita#prod/productshortname"></ph> performs a search using
-the <i>default</i> search filter.</p>
+<i><xref href="rrefproper27355.dita">derby.user.UserName</xref></i> property.
+For other users, <ph conref="../conrefs.dita#prod/productshortname"></ph>
+performs a search using the <i>default</i> search filter.</p>
<p>For more information about LDAP user authentication, see "Configuring LDAP
authentication" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
</section>
Modified: db/derby/docs/trunk/src/ref/rrefproper39325.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper39325.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper39325.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper39325.dita Fri Jun 20 20:03:18 2014
@@ -18,25 +18,26 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper39325">
<title>derby.database.readOnlyAccessUsers</title>
+<shortdesc>The <i>derby.database.readOnlyAccessUsers</i> property, one of the
+user authorization properties, specifies a list of users to which read-only
+access to a database is granted.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.database.readOnlyAccessUsers</indexterm>
+<keywords><indexterm>derby.database.readOnlyAccessUsers property</indexterm>
<indexterm>User authorization<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>One of the user authorization properties. Specifies a list of users to
-which read-only access to a database is granted. The list consists of user
-names separated by commas. Do not put spaces after commas.</p>
+<section>
+<p>The list consists of user names separated by commas. Do not put spaces after
+the commas.</p>
<p>When set as a system property, specifies a list of users for which read-only
access to all the databases in the system is granted.</p>
-<p>See also
-<i><xref href="rrefproper25025.dita#rrefproper25025">derby.database.fullAccessUsers</xref></i>.</p>
<p>A malformed list of user names raises an exception. Do not specify a user
-both in this property and in <i>derby.database.fullAccessUsers</i>.</p>
-<note>User names, called authorization identifiers,
-follow the rules of <i>SQL92Identifiers</i> and can be delimited.
-Specifying a user name that does not follow these rules raises an exception.</note>
+both in this property and in
+<i><xref href="rrefproper25025.dita">derby.database.fullAccessUsers</xref></i>.</p>
+<note>User names, called authorization identifiers, follow the rules of
+<i>SQL92Identifiers</i> and can be delimited. Specifying a user name that does
+not follow these rules raises an exception.</note>
</section>
<refsyn><title>Syntax</title>
<codeblock><b><b>-- database-level property</b>
@@ -54,5 +55,5 @@ derby.database.readOnlyAccessUsers=ralph
<section><title>Dynamic or static</title>
<p>Dynamic. Current connection is not affected, but all future connections
are affected. For information about dynamic changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+<xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper40346.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper40346.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper40346.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper40346.dita Fri Jun 20 20:03:18 2014
@@ -18,17 +18,18 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper40346">
<title>derby.locks.escalationThreshold</title>
+<shortdesc>The <i>derby.locks.escalationThreshold</i> property is used by the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system at runtime in
+determining when to attempt to escalate locking for at least one of the tables
+involved in a transaction from row-level locking to table-level
+locking.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.locks.escalationThreshold</indexterm>
+<keywords><indexterm>derby.locks.escalationThreshold property</indexterm>
<indexterm>Lock escalation</indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Used by the <ph conref="../conrefs.dita#prod/productshortname"></ph> system
-at runtime in determining when to attempt to escalate locking for at least one
-of the tables involved in a transaction from row-level locking to table-level
-locking.</p>
+<section>
<p>A large number of row locks use a lot of resources. If nearly all the rows
are locked, it might be worth the slight decrease in concurrency to lock the
entire table to avoid the large number of row locks.</p>
@@ -60,6 +61,5 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper40688.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper40688.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper40688.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper40688.dita Fri Jun 20 20:03:18 2014
@@ -20,17 +20,19 @@ limitations under the License.
-->
<reference id="rrefproper40688" xml:lang="en-us">
<title>derby.storage.pageSize</title>
+<shortdesc>The <i>derby.storage.pageSize</i> property defines the page size, in
+bytes, for on-disk database pages for tables or indexes used during table or
+index creation.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.storage.pageSize</indexterm>
+<keywords><indexterm>derby.storage.pageSize property</indexterm>
<indexterm>Page size<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Defines the page size, in bytes, for on-disk database pages for tables or
-indexes used during table or index creation. Set this property prior to issuing
-the CREATE TABLE or CREATE INDEX statement. This value will be used for the
-lifetime of the newly created conglomerates.</p>
+<section>
+<p>Set this property prior to issuing the CREATE TABLE or CREATE INDEX
+statement. This value will be used for the lifetime of the newly created
+conglomerates.</p>
</section>
<section><title>Valid conglomerates</title>
<p>Tables and indexes, including the indexes created to enforce constraints.</p>
@@ -62,7 +64,7 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
<p>This property is dynamic; if you change it while
<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
takes effect immediately. For information about dynamic changes to properties,
-see <xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+see <xref href="crefproperdynstat.dita"/>.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper43414.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper43414.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper43414.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper43414.dita Fri Jun 20 20:03:18 2014
@@ -18,18 +18,19 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper43414">
<title>derby.language.logQueryPlan</title>
+<shortdesc>The <i>derby.language.logQueryPlan</i> property, when set to true,
+tells <ph conref="../conrefs.dita#prod/productshortname"></ph> to write the
+query plan information into the <codeph>derby.log</codeph> file for all executed
+queries.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.language.logQueryPlan</indexterm>
+<keywords><indexterm>derby.language.logQueryPlan property</indexterm>
<indexterm>Statement execution<indexterm>debugging</indexterm></indexterm>
<indexterm>Statements<indexterm>debugging</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>When this property is set to true,
-<ph conref="../conrefs.dita#prod/productshortname"></ph> writes the query plan
-information into the <codeph>derby.log</codeph> file for all executed queries.
-This information can help you debug problems within a system.</p>
+<section>
+<p>This information can help you debug problems within a system.</p>
</section>
<example><title>Example</title>
<codeblock><b>derby.language.logQueryPlan=true</b></codeblock>
Modified: db/derby/docs/trunk/src/ref/rrefproper43517.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper43517.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper43517.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper43517.dita Fri Jun 20 20:03:18 2014
@@ -18,19 +18,21 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper43517">
<title>derby.language.logStatementText</title>
+<shortdesc>The <i>derby.language.logStatementText</i> property, when set to
+true, tells
+<ph conref="../conrefs.dita#prod/productshortname"></ph> to write the text and
+parameter values of all executed statements to the information log at the
+beginning of execution.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.language.logStatementText</indexterm>
+<keywords><indexterm>derby.language.logStatementText property</indexterm>
<indexterm>Statement execution<indexterm>debugging</indexterm></indexterm>
<indexterm>Statements<indexterm>debugging</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>When this property is set to true,
-<ph conref="../conrefs.dita#prod/productshortname"></ph> writes the text and
-parameter values of all executed statements to the information log at the
-beginning of execution. It also writes information about commits and rollbacks.
-Information includes the time and thread number.</p>
+<section>
+<p>It also writes information about commits and rollbacks. Information includes
+the time and thread number.</p>
<p>This property is useful for debugging.</p>
</section>
<example><title>Example</title>
Modified: db/derby/docs/trunk/src/ref/rrefproper46141.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper46141.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper46141.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper46141.dita Fri Jun 20 20:03:18 2014
@@ -18,18 +18,18 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper46141">
<title>derby.locks.waitTimeout</title>
+<shortdesc>The <i>derby.locks.waitTimeout</i> property specifies the number of
+seconds after which <ph conref="../conrefs.dita#prod/productshortname"></ph>
+aborts a transaction when it is waiting for a lock.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.locks.waitTimeout</indexterm>
+<keywords><indexterm>derby.locks.waitTimeout property</indexterm>
<indexterm>Deadlocks<indexterm>wait timeout property</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies the number of seconds after which
-<ph conref="../conrefs.dita#prod/productshortname"></ph> aborts a transaction
-when it is waiting for a lock. When
-<ph conref="../conrefs.dita#prod/productshortname"></ph> aborts (and rolls back)
-the transaction, the transaction receives an <i>SQLException</i> of
+<section>
+<p>When <ph conref="../conrefs.dita#prod/productshortname"></ph> aborts (and
+rolls back) the transaction, the transaction receives an <i>SQLException</i> of
<i>SQLState</i> 40XL1.</p>
<p>The time specified by this property is approximate.</p>
<p>A zero value for this property means that
@@ -39,7 +39,7 @@ any time it cannot immediately obtain a
the transaction waits forever to obtain the lock.</p>
<p>If this property is set to a value greater than or equal to zero but less
than the value of
-<i><xref href="rrefproper10607.dita#rrefproper10607">derby.locks.deadlockTimeout</xref></i>,
+<i><xref href="rrefproper10607.dita">derby.locks.deadlockTimeout</xref></i>,
<ph conref="../conrefs.dita#prod/productshortname"></ph> never performs any
deadlock checking.</p>
</section>
@@ -53,6 +53,5 @@ derby.locks.waitTimeout=60</b></codebloc
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproper81359.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper81359.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper81359.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper81359.dita Fri Jun 20 20:03:18 2014
@@ -20,27 +20,27 @@ limitations under the License.
-->
<reference id="rrefproper81359" xml:lang="en-us">
<title>derby.storage.pageCacheSize</title>
+<shortdesc>The <i>derby.storage.pageCacheSize</i> property defines the size, in
+number of pages, of the data page cache in the database (data pages kept in
+memory).</shortdesc>
<prolog><metadata>
<keywords>
-<indexterm>derby.storage.pageCacheSize</indexterm>
+<indexterm>derby.storage.pageCacheSize property</indexterm>
<indexterm>Page cache size<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Defines the size, in number of pages, of the data page cache in the database
-(data pages kept in memory).</p>
+<section>
<p>The actual amount of memory the page cache will use depends on the
following:</p>
<ul>
<li>The size of the cache, configured with the
<i>derby.storage.pageCacheSize</i> property.</li>
<li>The size of the pages, configured with the
-<i><xref href="rrefproper40688.dita#rrefproper40688">derby.storage.pageSize</xref></i>
-property. <ph conref="../conrefs.dita#prod/productshortname"></ph> automatically
-tunes for the database page size. If you have long columns, the default page
-size for the table is set to 32768 bytes. Otherwise, the default is 4096
-bytes.</li>
+<i><xref href="rrefproper40688.dita">derby.storage.pageSize</xref></i> property.
+<ph conref="../conrefs.dita#prod/productshortname"></ph> automatically tunes for
+the database page size. If you have long columns, the default page size for the
+table is set to 32768 bytes. Otherwise, the default is 4096 bytes.</li>
<li>Overhead, which varies with JVMs.</li>
</ul>
<p>When increasing the size of the page cache, you typically have to allow more
Modified: db/derby/docs/trunk/src/ref/rrefproper81405.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper81405.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper81405.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper81405.dita Fri Jun 20 20:03:18 2014
@@ -18,15 +18,16 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper81405">
<title>derby.database.forceDatabaseLock</title>
+<shortdesc>The <i>derby.database.forceDatabaseLock</i> property, if set to true
+on some platforms, prevents
+<ph conref="../conrefs.dita#prod/productshortname"></ph> from booting a database
+if a <i>db.lck</i> file is present in the database directory.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.database.forceDatabaseLock</indexterm>
+<keywords><indexterm>derby.database.forceDatabaseLock property</indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>On some platforms, if set to true, prevents
-<ph conref="../conrefs.dita#prod/productshortname"></ph> from booting a database
-if a <i>db.lck</i> file is present in the database directory.</p>
+<section>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> attempts to prevent
two JVMs from accessing a database at one time (and potentially corrupting it)
with the use of a file called <i>db.lck</i> in the database directory. On some
Modified: db/derby/docs/trunk/src/ref/rrefproper98166.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper98166.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper98166.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper98166.dita Fri Jun 20 20:03:18 2014
@@ -18,16 +18,18 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproper98166">
<title>derby.locks.monitor</title>
+<shortdesc>The <i>derby.locks.monitor</i> property specifies that all deadlock
+errors are logged to the error log.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.locks.monitor</indexterm>
+<keywords><indexterm>derby.locks.monitor property</indexterm>
<indexterm>Locks<indexterm>monitoring</indexterm></indexterm>
<indexterm>Deadlocks<indexterm>monitoring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies that all deadlock errors are logged to the error log. If
-<i><xref href="rrefproper26985.dita#rrefproper26985">derby.stream.error.logSeverityLevel</xref></i>
+<section>
+<p>If
+<i><xref href="rrefproper26985.dita">derby.stream.error.logSeverityLevel</xref></i>
is set to ignore deadlock errors, <i>derby.locks.monitor</i> overrides it.</p>
</section>
<section><title>Default</title>
@@ -42,6 +44,5 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section></refbody></reference>
Modified: db/derby/docs/trunk/src/ref/rrefproperauthdn.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperauthdn.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperauthdn.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperauthdn.dita Fri Jun 20 20:03:18 2014
@@ -18,19 +18,18 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproperauthdn">
<title>derby.authentication.ldap.searchAuthDN</title>
+<shortdesc>Along with <i>derby.authentication.ldap.searchAuthPW</i>, the
+<i>derby.authentication.ldap.searchAuthDN</i> property indicates how
+<ph conref="../conrefs.dita#prod/productshortname"></ph> should bind with the
+LDAP directory server to do searches for user DN (distinguished name).</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.authentication.ldap.searchAuthDN</indexterm>
+<keywords><indexterm>derby.authentication.ldap.searchAuthDN property</indexterm>
<indexterm>LDAP<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Along with
-<i><xref href="rrefproperauthpw.dita#rrefproperauthpw">derby.authentication.ldap.searchAuthPW</xref></i>,
-this property indicates how
-<ph conref="../conrefs.dita#prod/productshortname"></ph> should bind with the
-LDAP directory server to do searches for user DN (distinguished name). This
-property specifies the DN; <i>derby.authentication.ldap.searchAuthPW</i>
+<section>
+<p>This property specifies the DN; <i><xref href="rrefproperauthpw.dita"/></i>
specifies the password to use for the search.</p>
<p>If these two properties are not specified, an anonymous search is performed
if it is supported.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproperauthpw.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperauthpw.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperauthpw.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperauthpw.dita Fri Jun 20 20:03:18 2014
@@ -20,19 +20,20 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefproperauthpw" xml:lang="en-us">
<title>derby.authentication.ldap.searchAuthPW</title>
+<shortdesc>Along with <i>derby.authentication.ldap.searchAuthDN</i>, the
+<i>derby.authentication.ldap.searchAuthPW</i> property indicates how
+<ph conref="../conrefs.dita#prod/productshortname"></ph> should bind with the
+directory server to do searches in order to retrieve a fully qualified user DN
+(distinguished name).</shortdesc>
<prolog><metadata>
-<keywords><indexterm>authentication.ldap.searchAuthPW</indexterm>
+<keywords><indexterm>authentication.ldap.searchAuthPW property</indexterm>
<indexterm>LDAP<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Along with
-<i><xref href="rrefproperauthdn.dita#rrefproperauthdn">derby.authentication.ldap.searchAuthDN</xref></i>,
-indicates how <ph conref="../conrefs.dita#prod/productshortname"></ph> should
-bind with the directory server to do searches in order to retrieve a fully
-qualified user DN (distinguished name). This property specifies the password;
-<i>derby.authentication.ldap.searchAuthDN</i> specifies the DN to use for the
+<section>
+<p> This property specifies the password;
+<i><xref href="rrefproperauthdn.dita"/></i> specifies the DN to use for the
search.</p>
<p>For more information about LDAP user authentication, see "Configuring LDAP
authentication" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproperbootall.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperbootall.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperbootall.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperbootall.dita Fri Jun 20 20:03:18 2014
@@ -18,27 +18,27 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproperbootall">
<title>derby.system.bootAll</title>
+<shortdesc>The <i>derby.system.bootAll</i> property specifies that all databases
+in the directory specified by the <i>derby.system.home</i> property should be
+automatically booted at startup time.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.system.bootAll</indexterm>
+<keywords><indexterm>derby.system.bootAll property</indexterm>
<indexterm>databases<indexterm>configuring autobooting</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies that all databases in the directory specified by the
-<i><xref href="rrefproper32066.dita#rrefproper32066">derby.system.home</xref></i>
-property should be automatically booted at startup time.</p>
-<p>When this property is set to true, databases in the <i>derby.system.home</i>
-directory are booted at startup. Otherwise, databases are booted when you
-first connect to them.</p>
+<section>
+<p>When this property is set to true, databases in the
+<i><xref href="rrefproper32066.dita">derby.system.home</xref></i> directory are
+booted at startup. Otherwise, databases are booted when you first connect to
+them.</p>
<p>You may want to use the <i>derby.system.bootAll</i> property to avoid a
delay at first connection time. After a crash, a boot that requires recovery
can take a long time, and you may want to perform this boot as soon as
<ph conref="../conrefs.dita#prod/productshortname"></ph> is restarted.</p>
-<p>You can set the <i>derby.database.noAutoBoot</i> property on a particular
-database if you want to prevent it from being automatically booted at startup.
-See <i><xref href="rrefpropernoautoboot.dita#rrefpropernoautoboot"/></i> for
-details.</p>
+<p>You can set the <i><xref href="rrefpropernoautoboot.dita"/></i> property on a
+particular database if you want to prevent it from being automatically booted at
+startup.</p>
</section>
<section><title>Default</title>
<p>False.</p>
Modified: db/derby/docs/trunk/src/ref/rrefproperbuiltinalgorithm.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperbuiltinalgorithm.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperbuiltinalgorithm.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperbuiltinalgorithm.dita Fri Jun 20 20:03:18 2014
@@ -18,19 +18,20 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference id="rrefproperbuiltinalgorithm" xml:lang="en-us">
<title>derby.authentication.builtin.algorithm</title>
+<shortdesc>The <i>derby.authentication.builtin.algorithm</i> property specifies
+the message digest algorithm to use to protect the passwords that are stored in
+the database when using NATIVE authentication.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.authentication.builtin.algorithm</indexterm>
+<keywords><indexterm>derby.authentication.builtin.algorithm property</indexterm>
<indexterm>authentication algorithm<indexterm>configuring</indexterm></indexterm>
<indexterm>message digest algorithm<indexterm>configuring</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies the message digest algorithm to use to protect the passwords that
-are stored in the database when using NATIVE authentication. The value is the
-name of a message digest algorithm available from one of the Java Cryptography
-Extension (JCE) providers registered in the JVM. Some examples of valid values
-are MD5, SHA-256, and SHA-512.</p>
+<section>
+<p>The value is the name of a message digest algorithm available from one of the
+Java Cryptography Extension (JCE) providers registered in the JVM. Some examples
+of valid values are MD5, SHA-256, and SHA-512.</p>
<p>The specified algorithm will be applied on the concatenation of the user name
and the password before it is stored in the database.</p>
</section>
@@ -53,8 +54,7 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefproperclasspath.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperclasspath.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperclasspath.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperclasspath.dita Fri Jun 20 20:03:18 2014
@@ -18,20 +18,20 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproperclasspath">
<title>derby.database.classpath</title>
+<shortdesc>The <i>derby.database.classpath</i> property specifies the classpath
+that <ph conref="../conrefs.dita#prod/productshortname"></ph> should use when
+searching for jar files in a database.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.database.classpath</indexterm>
+<keywords><indexterm>derby.database.classpath property</indexterm>
<indexterm>database-wide properties<indexterm>setting classpath for jar
files</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Specifies the classpath that
-<ph conref="../conrefs.dita#prod/productshortname"></ph> should use when
-searching for jar files in a database. This property must be set to
-enable <ph conref="../conrefs.dita#prod/productshortname"></ph> to load classes
-from jar files installed with the <xref
-href="rrefstorejarinstall.dita#rrefstorejarinstall"></xref>.</p>
+<section>
+<p>This property must be set to enable
+<ph conref="../conrefs.dita#prod/productshortname"></ph> to load classes from
+jar files installed with the <xref href="rrefstorejarinstall.dita"/>.</p>
<p>Make sure to do the following:</p>
<ul>
<li>Separate jar files with a colon (<codeph>:</codeph>).</li>
@@ -49,7 +49,7 @@ and resources in the order specified by
<p>For more information, see the section "Loading classes from a database" in
the <ph conref="../conrefs.dita#pub/citdevelop"></ph>. For reference information
on system procedures for storing jar files in a database, see
-"<xref href="crefstorejardb.dita#crefstorejardb"></xref>."</p>
+"<xref href="crefstorejardb.dita"/>."</p>
</section>
<refsyn><title>Syntax</title>
<codeblock><b>-- database-level property
@@ -65,8 +65,7 @@ CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPE
</example>
<section><title>Dynamic or static</title>
<p>Dynamic; the change takes effect immediately. For information about dynamic
-changes to properties, see
-<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+changes to properties, see <xref href="crefproperdynstat.dita"/>.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefproperdatadictversion.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperdatadictversion.dita?rev=1604269&r1=1604268&r2=1604269&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperdatadictversion.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperdatadictversion.dita Fri Jun 20 20:03:18 2014
@@ -18,27 +18,27 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
<reference xml:lang="en-us" id="rrefproperdatadictversion">
<title>DataDictionaryVersion</title>
+<shortdesc>The <i>DataDictionaryVersion</i> property shows the version of the
+on-disk data in the database.</shortdesc>
<prolog><metadata>
<keywords><indexterm>DataDictionaryVersion property</indexterm>
<indexterm>database-wide properties<indexterm>retrieving database version</indexterm></indexterm>
</keywords>
</metadata>
</prolog><refbody>
-<section><title>Function</title>
-<p>Shows the version of the on-disk data in the database. The version is the
-first two numbers (the major and minor release values) in a
-<ph conref="../conrefs.dita#prod/productshortname"></ph> release identifier. For
-newly created databases and for soft-upgraded databases, this is the release
+<section>
+<p>The version is the first two numbers (the major and minor release values) in
+a <ph conref="../conrefs.dita#prod/productshortname"></ph> release identifier.
+For newly created databases and for soft-upgraded databases, this is the release
identifier of the <ph conref="../conrefs.dita#prod/productshortname"></ph>
engine jar used to create the database. For fully upgraded databases, this is
the release identifier of the
<ph conref="../conrefs.dita#prod/productshortname"></ph> engine jar used to
perform a full upgrade of the database. See
-<xref href="rrefattribupgrade.dita#rrefattribupgrade"></xref> for more
-information about upgrading databases.</p>
+<xref href="rrefattribupgrade.dita"><i>upgrade=true</i> attribute</xref> for
+more information about upgrading databases.</p>
<p>You can retrieve the value of this property by using the
-<xref href="rrefgetdbpropfunc.dita#rrefgetdbpropfunc"></xref>, but you cannot
-change it.</p>
+<xref href="rrefgetdbpropfunc.dita"/>, but you cannot change it.</p>
</section>
<refsyn><title>Syntax</title>
<codeblock><b>-- database-level property