db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r448772 - in /db/derby/docs/trunk/src: getstart/ workingwithderby/
Date Fri, 22 Sep 2006 02:23:51 GMT
Author: jta
Date: Thu Sep 21 19:23:50 2006
New Revision: 448772

URL: http://svn.apache.org/viewvc?view=rev&rev=448772
Log:
DERBY-1821 Minor edits to the Getting Started Guide and to Working With Derby.

Patch DERBY-1821_getstart_20060921.diff by Myrna van Lunteren <m.v.lunteren@gmail.com>.

Modified:
    db/derby/docs/trunk/src/getstart/cgsinstallingderby.dita
    db/derby/docs/trunk/src/getstart/cgsquck13780.dita
    db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
    db/derby/docs/trunk/src/getstart/rgsdocs10012.dita
    db/derby/docs/trunk/src/getstart/rgslib46043.dita
    db/derby/docs/trunk/src/getstart/rgsquck30197.dita
    db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita
    db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita

Modified: db/derby/docs/trunk/src/getstart/cgsinstallingderby.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsinstallingderby.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsinstallingderby.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsinstallingderby.dita Thu Sep 21 19:23:50 2006
@@ -57,9 +57,11 @@
 utilities and setting up the environment.</li>
 <li>The <filepath>javadoc</filepath> subdirectory contains the <codeph>api</codeph>
documentation
 that was generated from source code comments.</li>
-<li>The <filepath>doc</filepath> subdirectory contains the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
documentation.</li>
-<li>The <filepath>lib</filepath> subdirectory contains the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
jar
+<li>The <filepath>docs</filepath> subdirectory contains the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
documentation.</li>
+<li>The <filepath>lib</filepath> subdirectory contains the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
jar 
 files.</li>
+<li>The <filepath>test</filepath> subdirectory contains regression tests
for <ph conref="gsconrefs.dita#prod/productshortname"></ph>.</li>
+<li>The <filepath>frameworks</filepath> subdirectory contains older style
scripts for executing utilities and setting up the environment. These are provided in this
release for backward compatibility. In a next release, they will be deprecated in favor of
the scripts in the <filepath>bin</filepath> directory. </li>
 </ul></p>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/getstart/cgsquck13780.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsquck13780.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsquck13780.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsquck13780.dita Thu Sep 21 19:23:50 2006
@@ -31,7 +31,7 @@
 a server framework that allows multiple network connections. (The framework
 itself starts an instance of <ph conref="gsconrefs.dita#prod/productshortname"></ph>
and
 runs in an embedded environment. However, the client applications do not run
-in the embedded environment. )</p>
+in the embedded environment.)</p>
 <p>You can also embed <ph conref="gsconrefs.dita#prod/productshortname"></ph>
in
 any Java server framework. </p>
 <p>See the <cite><ph conref="gsconrefs.dita#pub/citadmin"></ph></cite>
for

Modified: db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita Thu Sep 21 19:23:50 2006
@@ -45,7 +45,7 @@
 Server, use the following commands: <ul>
 <li>For the <cmdname>dblook</cmdname> tool, call the script and specify
the
 -d option and the full URL to the Network Server database. For example: <codeph>dblook
--d 'jdbc:derby://localhost/myDB;user=usr;'</codeph> </li>
+-d 'jdbc:derby://localhost/myDB;user=usr'</codeph> </li>
 <li>For the <cmdname>ij</cmdname> tool, issue the command <codeph>set
DERBY_OPTS=-Dij.protocol=jdbc:derby://localhost/</codeph> and
 then start <cmdname>ij</cmdname> by issuing the command <codeph>ij</codeph>.</li>
 <li>For the <cmdname>sysinfo</cmdname> tool, issue the command <codeph>NetworkServerControl

Modified: db/derby/docs/trunk/src/getstart/rgsdocs10012.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgsdocs10012.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgsdocs10012.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgsdocs10012.dita Thu Sep 21 19:23:50 2006
@@ -34,7 +34,7 @@
 <tbody>
 <row>
 <entry colname="1"><codeph>|</codeph></entry>
-<entry colname="2">“or.” Choose one of the items</entry>
+<entry colname="2">or. Choose one of the items</entry>
 </row>
 <row>
 <entry colname="1"><codeph>[ ]</codeph></entry>
@@ -61,8 +61,6 @@
   ON <b><i>TableName</i></b> ( <b><i>SimpleColumnName</i></b>
[ , <b><i>SimpleColumnName</i></b> ] * ) </b></codeblock></p></section>
 <section><p>Command-line syntax for running Java programs and utilities (as
 well as examples) always begins with the word <i>java</i>: <codeblock>java
org.apache.derby.tools.ij</codeblock></p></section>
-<section><p>In addition, this documentation uses the IBM Software Development
-Kit style for setting JVM arguments and properties. If you use another Java
-Virtual Machine, the way you set JVM arguments and properties might be different.</p></section>
+<section><p>This documentation attempts to be JVM neutral, but any command line
examples or syntax using JVM specific references should be verified with your JVM documentation.</p></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/getstart/rgslib46043.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgslib46043.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgslib46043.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgslib46043.dita Thu Sep 21 19:23:50 2006
@@ -24,7 +24,7 @@
 <prolog><metadata>
 <keywords><indexterm>derbyclient.jar</indexterm><indexterm>derby.jar</indexterm>
 <indexterm>derbytools.jar</indexterm><indexterm>Sample application libraries</indexterm>
-<indexterm>Sample database libraries</indexterm></keywords>
+<indexterm>Sample database libraries</indexterm><indexterm>derbyrun.jar</indexterm></keywords>
 </metadata></prolog>
 <refbody>
 <table frame="all"><title>Derby libraries and their use</title>
@@ -38,7 +38,7 @@
 </thead>
 <tbody>
 <row>
-<entry nameend="2" namest="1"><b>Engine libraries</b>   <p>You always
need
+<entry nameend="2" namest="1"><b>Engine library</b>   <p>You always
need
 this library for embedded environments. For client/server environments, you
 only need this library on the server.</p></entry>
 </row>
@@ -57,7 +57,11 @@
 (such as ij, dblook, and import/export). </entry>
 </row>
 <row>
-<entry nameend="2" namest="1"><b>The Network Server libraries</b></entry>
+<entry colname="1">derbyrun.jar</entry>
+<entry colname="2">Executable jar file that can be used to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
tools. </entry>
+</row>
+<row>
+<entry nameend="2" namest="1"><b>The Network Server library</b></entry>
 </row>
 <row>
 <entry colname="1">derbynet.jar</entry>
@@ -65,7 +69,7 @@
 Server.</entry>
 </row>
 <row>
-<entry nameend="2" namest="1"><b>The network client libraries</b></entry>
+<entry nameend="2" namest="1"><b>The network client library</b></entry>
 </row>
 <row>
 <entry colname="1">derbyclient.jar</entry>

Modified: db/derby/docs/trunk/src/getstart/rgsquck30197.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/rgsquck30197.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/rgsquck30197.dita (original)
+++ db/derby/docs/trunk/src/getstart/rgsquck30197.dita Thu Sep 21 19:23:50 2006
@@ -36,10 +36,10 @@
 </ul></p></section>
 <section><p>For the <ph conref="gsconrefs.dita#prod/productshortname"></ph>-provided
 network client driver, the format for the database connection URL for connecting
-to a database is this:   <codeblock>jdbc:derby://&lt;server>[:&lt;port>]/
-<i>databaseName</i>[;<i>URLAttributes</i>=&lt;value> [;...]]</codeblock>where
+to a database is this:   <codeblock>jdbc:derby://&lt;server>[:&lt;port>]/<i>databaseName</i>[;<i>URLAttributes</i>=&lt;value>[;...]]</codeblock>where
 the &lt;server> and &lt;port> specify the host name (or IP address) and port
-number where the server is listening for requests. The <i>URLAttributes</i> can
+number where the server is listening for requests and <i>databaseName</i> is
the 
+name of the database you want to connect to. The <i>URLAttributes</i> can
 be either <ph conref="gsconrefs.dita#prod/productshortname"></ph> embedded
 or network client attributes. See the <ph conref="gsconrefs.dita#pub/citadmin"></ph>
for
 more information on accessing the Network Server by using the network client.</p></section>

Modified: db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita (original)
+++ db/derby/docs/trunk/src/getstart/tgssetupjavaenvir.dita Thu Sep 21 19:23:50 2006
@@ -22,7 +22,7 @@
 <title>Setting up your environment</title>
 <shortdesc>You need to set several environment variables so that the scripts
 that are included with the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
<codeph>bin</codeph> distribution
-run correctly.</shortdesc>
+run correctly. These scripts need to be run in an appropriate command line environment, i.e.
a "Command Prompt" on Windows or a shell on Unix.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Derby<indexterm>environment setup</indexterm></indexterm>
 <indexterm>environment variables<indexterm>DERBY_HOME</indexterm></indexterm>
@@ -39,10 +39,16 @@
 <step><cmd>Set the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph>
environment
 variable to the location where you extracted the <ph conref="gsconrefs.dita#prod/productshortname"></ph>
bin
 distribution.</cmd><stepxmp>For example, if you installed <ph conref="gsconrefs.dita#prod/productshortname"></ph>
in
-the c:\<ph conref="gsconrefs.dita#prod/productinstallname"></ph> directory,
+the c:\<ph conref="gsconrefs.dita#prod/productinstallname"></ph> directory on
Windows, or the /opt/<ph conref="gsconrefs.dita#prod/productinstallname"></ph>
directory on Unix,
 use the following command to set the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph>
environment
-variable:  <codeblock>set <ph conref="gsconrefs.dita#prod/productinstallpath"></ph>=c:\<ph
-conref="gsconrefs.dita#prod/productinstallname"></ph></codeblock></stepxmp>
+variable:</stepxmp> 
+<choicetable>
+<chhead><choptionhd>Operating System</choptionhd><chdeschd>Command</chdeschd>
+</chhead>
+<chrow><choption>UNIX</choption><chdesc><codeph>export <ph
conref="gsconrefs.dita#prod/productinstallpath"></ph>=/opt/<ph conref="gsconrefs.dita#prod/productinstallname"></ph></codeph></chdesc>
+</chrow>
+<chrow><choption>Windows</choption><chdesc><codeph>set <ph
conref="gsconrefs.dita#prod/productinstallpath"></ph>=c:\<ph conref="gsconrefs.dita#prod/productinstallname"></ph></codeph></chdesc></chrow>
+</choicetable>
 </step>
 <step><cmd>Set the JAVA_HOME environment variable. The JAVA_HOME environment
 variable is used by the scripts to locate the JVM and Java applications. </cmd>
@@ -63,15 +69,15 @@
 </chhead>
 <chrow><choption>UNIX</choption><chdesc><codeph>export PATH="$<ph
conref="gsconrefs.dita#prod/productinstallpath"></ph>/bin:$PATH"</codeph></chdesc>
 </chrow>
-<chrow><choption>Windows</choption><chdesc><codeph>set PATH=%<ph
conref="gsconrefs.dita#prod/productinstallpath"></ph>\bin;%PATH%</codeph></chdesc>
+<chrow><choption>Windows</choption><chdesc><codeph>set PATH=%<ph
conref="gsconrefs.dita#prod/productinstallpath"></ph>%\bin;%PATH%</codeph></chdesc>
 </chrow>
 </choicetable>
 <info>When the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph>
environment
-variable is set in the PATH environment variable, you can use shortened commands
+variable is set and the underlying bin directory is included in the PATH environment variable,
you can use shortened commands
 to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools. </info>
 </step>
 <step><cmd>Verify that the DERBY_HOME and the JAVA_HOME environment variables
-are set correctly, and that the $DERBY_HOME/bin directory is added to the
+are set correctly, and that the DERBY_HOME/bin directory is added to the
 PATH environment variable. </cmd><stepxmp>Use the following command to check
 the settings: <codeblock>sysinfo </codeblock></stepxmp><stepresult>If
the
 environment variables are set correctly, the sysinfo command displays information

Modified: db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita?view=diff&rev=448772&r1=448771&r2=448772
==============================================================================
--- db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita (original)
+++ db/derby/docs/trunk/src/workingwithderby/twwdIntro.dita Thu Sep 21 19:23:50 2006
@@ -39,7 +39,7 @@
 <context><p>Derby is a full featured, open source relational database engine.
 It is written and implemented completely in Java, and provides users with a
 small footprint standards-based database engine that can be tightly embedded
-into any Java based solution. Derby insures data integrity and provides sophisticated
+into any Java based solution. Derby ensures data integrity and provides sophisticated
 transaction support. In its default configuration there is no separate
 database server to be installed or maintained by the end user. For more information
 on Derby visit the Derby website at: <xref format="html" href="http://db.apache.org/derby"



Mime
View raw message