[jira] [Updated] (DERBY-6916) Doc of derbyrun.jar should describe complete list of referenced jars

["Bryan Pendleton (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DERBY-6916?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton updated DERBY-6916:
-----------------------------------
    Attachment: tadminappschangingyourclasspath.html
                adminguide.diff

Attached is a proposed diff to the admin guide's "Installing required jar files" topic page, and the HTML output that includes the resulting changes.

The intent is simply to make clear that, while derbyrun.jar automatically
includes derbytools.jar and derbyoptionaltools.jar, those jars are not
necessary to run the Derby Network Server.

The page kind of serves two purposes:
 - describing what's in derbyrun.jar
 - describing what you need in your CLASSPATH to run the Network Server

So the result is a bit of too much information for either purpose, but at
least it covers the bases.

I couldn't find anywhere else in our doc set where we state explicitly
what derbyrun.jar is, and how it relates to the other Derby jar files,
so updating this page seemed as good as anything.

bryan


> Doc of derbyrun.jar should describe complete list of referenced jars
> --------------------------------------------------------------------
>
>                 Key: DERBY-6916
>                 URL: https://issues.apache.org/jira/browse/DERBY-6916
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.14.0.0
>            Reporter: Bryan Pendleton
>            Priority: Minor
>         Attachments: adminguide.diff, tadminappschangingyourclasspath.html
>
>
> As I read our build.xml file:
> {quote}
> <manifest file="$
> Unknown macro: {derby.jar.dir}
> /lists/smfcmd.mf">
> <attribute name="Main-Class" value="org.apache.derby.iapi.tools.run"/>
> <attribute name="Class-Path" value="derby.jar derbyclient.jar derbytools.j
> ar derbynet.jar derbyoptionaltools.jar"/>
> </manifest>
> {quote}
> the derbyrun.jar filepulls both derbytools.jar and derbyoptionaltools.jar into my classpath.
> This means that both regular tools and optional tools can be run using only derbyrun.jar in the classpath.
> I think this indicates that this documentation is incorrect:
> https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/adminguide/tadminappschangingyourclasspath.html
> because it seemed to me to quite explicitly say that derbyrun.jar includes *ONLY* derby.jar, derbynet.jar, and derbyclient.jar.
> We should review that doc, and also any other doc that references derbyrun.jar, to make sure it is clear what it references and how to use it.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)