svn commit: r1847477 - in /db/derby/docs/trunk/src/tools: rtoolsoptlucene.dita ttoolsij11815.dita

[rh...@apache.org]

Author: rhillegas
Date: Mon Nov 26 15:20:24 2018
New Revision: 1847477

URL: http://svn.apache.org/viewvc?rev=1847477&view=rev
Log:
DERBY-6980: Tuning Guide changes related to modularization; commit derby-6980-12-aa-tuningGuide.diff.

Modified:
    db/derby/docs/trunk/src/tools/rtoolsoptlucene.dita
    db/derby/docs/trunk/src/tools/ttoolsij11815.dita

Modified: db/derby/docs/trunk/src/tools/rtoolsoptlucene.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsoptlucene.dita?rev=1847477&r1=1847476&r2=1847477&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsoptlucene.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsoptlucene.dita Mon Nov 26 15:20:24 2018
@@ -73,8 +73,10 @@ and "housing".</li>
 </section>
 <section><title>Classpath for running the luceneSupport optional tool</title>
 <p>Before you run the <codeph>luceneSupport</codeph> optional tool, make sure
-that your classpath contains the following jar files:</p>
+that your classpath/modulepath contains the following jar files:</p>
 <ul>
+<li><codeph>derbyshared.jar</codeph></li>
+<li><codeph>derbytools.jar</codeph></li>
 <li><codeph>derby.jar</codeph></li>
 <li><codeph>derbyoptionaltools.jar</codeph></li>
 <li><codeph>core</codeph>: The core Lucene machinery. For Lucene 4.5.0, this is

Modified: db/derby/docs/trunk/src/tools/ttoolsij11815.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij11815.dita?rev=1847477&r1=1847476&r2=1847477&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij11815.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij11815.dita Mon Nov 26 15:20:24 2018
@@ -41,6 +41,7 @@ environment. Follow the instructions in
 and <codeph>JAVA_HOME</codeph> environment variables and to add
 <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
 to your path. Then use the following command:</p><codeblock><b><userinput>ij [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock></context>
+
 <example>Alternatively, set the 
 <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph>
 environment variable, then use one of these commands:
@@ -48,20 +49,38 @@ environment variable, then use one of th
     [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
 <codeblock>(Windows) <b><userinput>java [<varname>options</varname>] -jar %DERBY_HOME%\lib\derbyrun.jar ij
     [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
-<codeblock><b><userinput>java [<varname>options</varname>] org.apache.derby.tools.ij 
-    [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
-<p>If you use the last form of the command, be sure that
-<codeph>derbyrun.jar</codeph> is in your classpath.</p>
-<p>If you need to use other classes in addition to
-<codeph>derbyrun.jar</codeph>, you cannot use the <codeph>-cp</codeph> argument
+
+<p>Note that you cannot use the <codeph>-cp</codeph> argument
 or the <codeph>CLASSPATH</codeph> environment variable to set
 <codeph>CLASSPATH</codeph> variables when you are using the
-<codeph>-jar</codeph> argument to start the <codeph>ij</codeph> tool. If you
-want to run the <codeph>ij</codeph> tool with a custom classpath, you cannot use
+<codeph>-jar</codeph> argument to start the <codeph>ij</codeph> tool. That is, if you
+want to run the <codeph>ij</codeph> tool with a custom classpath, then you cannot use
 the <codeph>-jar</codeph> argument. Instead, you have to  use the full class
 name to start the <codeph>ij</codeph> tool
 (<codeph>java org.apache.derby.tools.ij</codeph>). </p>
-<p>The command line items are:</p>    <ul>
+
+<p>
+You can also run the <codeph>ij</codeph> by setting the CLASSPATH or MODULEPATH variables
+via the <codeph>setNetworkServerCP</codeph> or <codeph>setNetworkServerCP.bat</codeph> scripts.
+Note that you first need to set <codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph>
+variable. To run <codeph>ij</codeph> from the CLASSPATH, type
+</p>
+<codeblock><b><userinput>java [<varname>options</varname>] org.apache.derby.tools.ij 
+    [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
+
+<p>
+To run <codeph>ij</codeph> from the MODULEPATH, type
+</p>
+<codeblock>(UNIX) <b><userinput>java -p $MODULEPATH \
+    -m org.apache.derby.tools/org.apache.derby.tools.ij \
+    [<varname>options</varname>]</userinput></b></codeblock> 
+<codeblock>(Windows) <b><userinput>java -p %MODULEPATH% ^
+    -m org.apache.derby.tools/org.apache.derby.tools.ij ^
+    [<varname>options</varname>]</userinput></b></codeblock> 
+
+<p>The command line items are:</p>
+
+<ul>
 <li><b><userinput>java</userinput></b>
 <p>Start the JVM.</p></li>
 <li><b><userinput><varname>options</varname></userinput></b>
@@ -81,7 +100,8 @@ end of the file or an <codeph>exit</code
 <codeph>ij</codeph> to print out the commands as it runs them. If you reroute
 standard input, <codeph>ij</codeph> does not print out the commands. If you do
 not supply an input file, <codeph>ij</codeph> reads from the standard input.</p></li>
-</ul></example>
+</ul>
+</example>
 <postreq><p>For detailed information about <codeph>ij</codeph> commands, see
 <xref href="rtoolsijcomref25570.dita">ij commands and errors
 reference</xref>.</p>