db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Updated: (DERBY-1662) Document derbyrun.jar
Date Wed, 24 Jan 2007 19:22:49 GMT

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

Kim Haase updated DERBY-1662:

    Attachment: DERBY-1662-2.zip

I've updated this patch with DERBY-1662-2.diff and DERBY-1662-2.zip.

I'm sorry to have submitted an incomplete patch. I did not actually make the Tools Guide changes
for the original patch. The updated diffs file includes the following changes to the Tools
Guide. The order below is the order in which the files appear in the Tools Guide, not the
order in which they appear in the diffs file. The zip file includes HTML versions of the previously
changed files from the Getting Started and Admin guides as well as these.

rtools1003161.dita (Classpath): removed the parts that applied to previous distributions,
since they aren't relevant to the current one and are therefore confusing. 

ttoolsij11815.dita (Starting ij): changed references to frameworks/bin directories to refer
to the bin directory instead. Changed topic to describe all three ways to invoke the utility
(script, derbyrun.jar, class).

ttoolsij30600.dita (Starting ij using properties): changed examples to use derbyrun.jar.

rtoolssysinfo41288.dita (sysinfo): changed the description to include all three ways to invoke
the utility (script, derbyrun.jar, class) instead of just the third.

rtoolssysinfo1002629.dita (sysinfo example): removed the clause about the classpath (no longer
relevant) and changed the command to use derbyrun.jar. Also updated some of the output information
to make it more current (Java version, Windows version) and updated the obsolete sentence
at the end, which appears to apply to a proprietary product.

ctoolsdblook.dita (dblook): changed the description to include all three ways to invoke the
utility (script, derbyrun.jar, class).

ctoolsusingdblook.dita (Using dblook): Changed to use the script version of the command (since
the focus here is on the options syntax rather than on invoking the command). Also corrected
the use of a variable.

Note that I did not update all the files to use derbyrun.jar instead of the class version
of the commands. I left untouched ttoolsij98878.dita (Running ij scripts), ctoolssysinfo1002931.dita
(Using sysinfo to check the classpath),  rtoolsdblookexamples.dita (dblook examples), and
many others (e.g. ij property examples). I did this partly because there is no harm in showing
all three ways to invoke the commands, and partly because the class version used in these
files doesn't require different formats for UNIX and Windows, while the derbyrun.jar version
does. If you think it would make sense to update all these files to use either derbyrun.jar
or the script version (which would also be platform-neutral, I think), I can do that. Just
let me know.

Thanks for all suggestions and corrections.

> Document derbyrun.jar
> ---------------------
>                 Key: DERBY-1662
>                 URL: https://issues.apache.org/jira/browse/DERBY-1662
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions:
>            Reporter: David Van Couvering
>         Assigned To: Kim Haase
>            Priority: Minor
>         Attachments: cgsusingtoolsutils.html, DERBY-1662-2.diff, DERBY-1662-2.zip, DERBY-1662.diff,
> The documentation for ij in the Tools Guide only describes how to start ij the old way.
 It should also describe how to start it using derbyrun.jar. 
> I wonder if the same is true for the other tools, although I haven't investigated.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message