svn commit: r1851944 - in /db/derby/docs/trunk/src/getstart: cgsusingtoolsutils.dita cgswhymodulepath.dita getstartderby.ditamap

[rh...@apache.org]

Author: rhillegas
Date: Wed Jan 23 15:28:32 2019
New Revision: 1851944

URL: http://svn.apache.org/viewvc?rev=1851944&view=rev
Log:
DERBY-7030: Add a section to the Getting Started Guide explaining why someone would boot Derby with a CLASSPATH versus a MODULEPATH; commit derby-7030-01-aa-classpathVSmodulepath.

Added:
    db/derby/docs/trunk/src/getstart/cgswhymodulepath.dita   (with props)
Modified:
    db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
    db/derby/docs/trunk/src/getstart/getstartderby.ditamap

Modified: db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita?rev=1851944&r1=1851943&r2=1851944&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita Wed Jan 23 15:28:32 2019
@@ -39,15 +39,15 @@ and <codeph>sysinfo</codeph>. To run the
 <li><xref href="tgsrunningdblook.dita#tgsrunningdblook"></xref></li>
 </ul>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> includes a set
-of scripts that you can use to start the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools.
+of scripts that you can use to start these tools.
+In addition, there are scripts for booting the Network Server.
 The scripts are located in the <ph conref="../conrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory.
 When you run these scripts, your CLASSPATH environment variable is set if
 you have not already set it, and remains set as long as you are running the
 tool.</p>
-<p>Most of the examples in this guide that show how to use the <ph conref="../conrefs.dita#prod/productshortname"></ph> scripts
-to launch the <ph conref="../conrefs.dita#prod/productshortname"></ph> tools
+<p>Most of the script examples in this guide
 assume that you are using the embedded mode of the <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-engine. Use the instructions below to run the scripts with the Network Server.</p>
+engine. Use the instructions below to run the tools scripts with the Network Server.</p>
 <section><title>Running the scripts with the Network Server</title><p>To run
 the scripts with the Network Server, use the following commands: <ul>
 <li>For the <codeph>sysinfo</codeph> tool, issue the command  <codeblock>NetworkServerControl sysinfo</codeblock></li>

Added: db/derby/docs/trunk/src/getstart/cgswhymodulepath.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgswhymodulepath.dita?rev=1851944&view=auto
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgswhymodulepath.dita (added)
+++ db/derby/docs/trunk/src/getstart/cgswhymodulepath.dita Wed Jan 23 15:28:32 2019
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
+<!--  
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+   http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<concept id="cgswhymodulepath" xml:lang="en-us">
+<title>CLASSPATH vs. MODULEPATH</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> software
+can be run with either a CLASSPATH or a MODULEPATH.</shortdesc>
+<conbody>
+<dl><dlentry>
+<dt>With a CLASSPATH</dt>
+<dd><p>The simplest way to run <ph conref="../conrefs.dita#prod/productshortname"></ph>
+is via the CLASSPATH. That is because the CLASSPATH is used by the scripts which
+start <ph conref="../conrefs.dita#prod/productshortname"></ph> configurations
+and by the handy <i>java -jar derbyrun.jar</i> shorthand for booting
+those configurations.</p>
+</dd>
+</dlentry><dlentry>
+<dt>With a MODULEPATH</dt>
+<dd><p>The MODULEPATH should be used if you want the extra security of
+module-level encapsulation which Java 9 introduced. In addition, the MODULEPATH
+should be used to reduce static footprint when assembling shrink-wrapped
+applications via the JDK's <i>jlink</i> tool.</p></dd>
+</dlentry></dl>
+</conbody>
+</concept>

Propchange: db/derby/docs/trunk/src/getstart/cgswhymodulepath.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/docs/trunk/src/getstart/getstartderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/getstartderby.ditamap?rev=1851944&r1=1851943&r2=1851944&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/getstartderby.ditamap (original)
+++ db/derby/docs/trunk/src/getstart/getstartderby.ditamap Wed Jan 23 15:28:32 2019
@@ -29,23 +29,35 @@ limitations under the License.
 <vrmlist><vrm version="@RELEASE_ID_SHORT@"/></vrmlist>
 <brand>Apache Derby</brand></prodinfo>
 </topicmeta>
+
 <reltable>
+
 <relrow>
 <relcell></relcell>
 <relcell></relcell>
 </relrow>
+
 <relrow>
 <relcell>
 <topicref href="cgsintro.dita" navtitle="Introduction to Derby"></topicref>
 </relcell>
 <relcell></relcell>
 </relrow>
+
+<relrow>
+<relcell>
+<topicref href="cgswhymodulepath.dita" navtitle="CLASSPATH vs. MODULEPATH"></topicref>
+</relcell>
+<relcell></relcell>
+</relrow>
+
 <relrow>
 <relcell>
 <topicref href="cgsintdo.dita" navtitle="Deployment options"></topicref>
 </relcell>
 <relcell></relcell>
 </relrow>
+
 <relrow>
 <relcell>
 <topicref href="cgsintsr.dita" navtitle="System requirements"></topicref>
@@ -296,6 +308,7 @@ limitations under the License.
 <topicref href="rgscopyright.dita" navtitle="Copyright"></topicref>
 <topicref href="rgslicense.dita" navtitle="License"></topicref>
 <topicref href="cgsintro.dita" navtitle="Introduction to Derby">
+<topicref href="cgswhymodulepath.dita" navtitle="CLASSPATH vs. MODULEPATH"></topicref>
 <topicref href="cgsintdo.dita" navtitle="Deployment options"></topicref>
 <topicref href="cgsintsr.dita" navtitle="System requirements"></topicref>
 <topicref href="rgsdocs17307.dita" navtitle="Product documentation for Derby">