You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Rick Hillegas (JIRA)" <ji...@apache.org> on 2018/11/16 20:08:00 UTC
[jira] [Comment Edited] (DERBY-6980) Documentation changes to
accompany jigsaw-modularization of derby
[ https://issues.apache.org/jira/browse/DERBY-6980?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16689952#comment-16689952 ]
Rick Hillegas edited comment on DERBY-6980 at 11/16/18 8:07 PM:
----------------------------------------------------------------
After checking in the misc changes, I intend to make the following, additional changes to the Derby docs in order to better describe version 10.15:
----
h2. Getting Started With Derby
* *System Requirements*: The minimum JVM version has been parameterized but it was still Java 6 until I checked in derby-6980-04-aa-updateDocsVariables.diff. The minimum.jdk variable in docs.properties needs to be updated by the release building machinery.
* *Setting up your environment*: Add a new sub-section titled "Booting Derby Configurations with a Modulepath" to describe how to boot Derby configurations via a modulepath.
* *Choosing a method to run the Derby tools and startup utilities*: The description of booting Derby via the java command needs to offer modulepath as an alternative to classpath.
* *Setting the environment variables*: Offer modulepath as an alternative to classpath.
* *Syntax for the derbyrun.jar file*: Under "Additional Information", note that you cannot use the module-aware command line switches either.
* *Running sysinfo*: Include instructions on how to run sysinfo with a modulepath.
* *Running ij*: Include instructions on how to run ij with a modulepath.
* *Running dblook*: Include instructions on how to run dblook with a modulepath.
* *Quick start guide for experienced JDBC users*: Change "set the classpath" to "set the classpath or modulepath".
* *Libraries provided by Derby*: Re-phrase this section in terms of modules and add a section for the shared module.
----
h2. Derby Reference Manual
* *JDBC reference*: Remove references to JDBC 4.1 and 4.2 from this section and its sub-sections.
----
h2. Derby Developer's Guide
* *Creating, dropping, and backing up databases*: Clarify what is meant by the cryptic instruction to consult getPropertyInfo().
----
h2. Derby Security Guide
* *Running embedded Derby with a security manager*: Remove this section because it is superceded by the amply commented embedded template engine policy.
----
h2. Tuning Derby
* *Put Derby first in your classpath*: Ask the experts whether the order of modules in the modulepath affects the speed of class loading.
----
h2. Derby Server and Administration Guide
* *Installing required jar files and adding them to the classpath/modulepath*: Add a bullet/paragraph on derbyshared.jar.
* *Starting the Network Server*: Revise verbiage about the template.policy file. Add a section on starting the server with a modulepath.
* *Network client driver examples*: Change the authentication examples to use NATIVE authentication rather than the deprecated and unsafe BUILTIN scheme. Yikes!
* *Differences between the embedded client and the network client driver*: Is it still true that you need an IBM JCE in order to encrypt username and password?
* *Running the SimpleNetworkServerSample program*: Add derbyshared.jar to the CLASSPATH.
* *Running the SimpleNetworkClientSample program*: Add derbyshared.jar to the CLASSPATH.
----
h2. Derby Tools and Utilities Guide
* *Starting ij*: Add option of using modulepath to start ij from the command line.
* *Using the luceneSupport optional tool*: Add derbyshared.jar and derbytools.jar to the classpath/modulepath.
* *Running the luceneSupport tool with a security manager*: Verify and if necessary update the security policy settings for running the Lucene plugin.
was (Author: rhillegas):
After checking in the misc changes, I intend to make the following, additional changes to the Derby docs in order to better describe version 10.15:
----
h2. Getting Started With Derby
* **System Requirements**: The minimum JVM version has been parameterized but it was still Java 6 until I checked in derby-6980-04-aa-updateDocsVariables.diff. The minimum.jdk variable in docs.properties needs to be updated by the release building machinery.
* **Setting up your environment**: Add a new sub-section titled "Booting Derby Configurations with a Modulepath" to describe how to boot Derby configurations via a modulepath.
* **Choosing a method to run the Derby tools and startup utilities**: The description of booting Derby via the java command needs to offer modulepath as an alternative to classpath.
* **Setting the environment variables**: Offer modulepath as an alternative to classpath.
* **Syntax for the derbyrun.jar file**: Under "Additional Information", note that you cannot use the module-aware command line switches either.
* **Running sysinfo**: Include instructions on how to run sysinfo with a modulepath.
* **Running ij**: Include instructions on how to run ij with a modulepath.
* **Running dblook**: Include instructions on how to run dblook with a modulepath.
* **Quick start guide for experienced JDBC users**: Change "set the classpath" to "set the classpath or modulepath".
* **Libraries provided by Derby**: Re-phrase this section in terms of modules and add a section for the shared module.
----
h2. Derby Reference Manual
* **JDBC reference**: Remove references to JDBC 4.1 and 4.2 from this section and its sub-sections.
----
h2. Derby Developer's Guide
* **Creating, dropping, and backing up databases**: Clarify what is meant by the cryptic instruction to consult getPropertyInfo().
----
h2. Derby Security Guide
* **Running embedded Derby with a security manager**: Remove this section because it is superceded by the amply commented embedded template engine policy.
----
h2. Tuning Derby
* **Put Derby first in your classpath**: Ask the experts whether the order of modules in the modulepath affects the speed of class loading.
----
h2. Derby Server and Administration Guide
* **Installing required jar files and adding them to the classpath/modulepath**: Add a bullet/paragraph on derbyshared.jar.
* **Starting the Network Server**: Revise verbiage about the template.policy file. Add a section on starting the server with a modulepath.
* **Network client driver examples**: Change the authentication examples to use NATIVE authentication rather than the deprecated and unsafe BUILTIN scheme. Yikes!
* **Differences between the embedded client and the network client driver**: Is it still true that you need an IBM JCE in order to encrypt username and password?
* **Running the SimpleNetworkServerSample program**: Add derbyshared.jar to the CLASSPATH.
* **Running the SimpleNetworkClientSample program**: Add derbyshared.jar to the CLASSPATH.
----
h2. Derby Tools and Utilities Guide
* **Starting ij**: Add option of using modulepath to start ij from the command line.
* **Using the luceneSupport optional tool**: Add derbyshared.jar and derbytools.jar to the classpath/modulepath.
* **Running the luceneSupport tool with a security manager": Verify and if necessary update the security policy settings for running the Lucene plugin.
> Documentation changes to accompany jigsaw-modularization of derby
> -----------------------------------------------------------------
>
> Key: DERBY-6980
> URL: https://issues.apache.org/jira/browse/DERBY-6980
> Project: Derby
> Issue Type: Task
> Components: Documentation
> Affects Versions: 10.15.0.0
> Reporter: Rick Hillegas
> Assignee: Rick Hillegas
> Priority: Major
> Attachments: derby-6980-01-aa-moduleDiagramsInJavadoc.diff, derby-6980-02-aa-addOverviewPageToInternalJavadoc.diff, derby-6980-03-aa-securityPolicies.diff, derby-6980-03-aa-securityPolicies.tar, derby-6980-04-aa-updateDocsVariables.diff, derby-6980-05-aa-miscCleanup.diff, derby-6980-05-aa-miscCleanup.tar
>
>
> This is a place to collect the documentation changes which must be made as a result of the work on DERBY-6945.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)