db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-1223) Update Getting Started to include instructions on setting JAVA_HOME variable.
Date Tue, 22 Aug 2006 18:57:14 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12429779 ] 
Kim Haase commented on DERBY-1223:

> 1) When is it appropriate to have classpath in uppercase... such as CLASSPATH?  Normally
we do this for the name of things, like environment variables.

I think your instinct is right on this. The word "classpath" is normally in lowercase as a
term; it should be in uppercase only as part of the phrase "the CLASSPATH environment variable".
The scripts we tell users to run actually do set the CLASSPATH environment variable, so tgs26250
should be very explicit about which is which. (BTW, that file also contains an occurrence
of "class path", which should be all one word.)

> 2) In the filetgssetupjavanvir, I am not certain that I acturately captured all of the
changes that you requested.

I think part of the material from tgs36360 has not been incorporated -- there should be a
step about how to set DERBY_HOME (formerly DERBY_INSTALL). Possibly the second paragraph of
step 2 should actually come before step 2 and should begin "When the DERBY_HOME environment
variable ..." and add this info? (In the same paragraph, there's a missing space between "the"
and "DERBY_HOME".)

And also in step 2, the first line of the example has a forward slash instead of a backslash
in a Windows command. This is in Andrew's text -- maybe it even works, but I think it is more
likely a typo.

Couple of other comments:


Consistency issue -- normally an environment variable doesn't have the "$" in front of it
(I think even in a UNIX-specific context). (I think there are other occurrences of this, for
example in tgssetupjavaenvir.)

Another consistency issue: UNIX, not Unix.

Also, the version of 10.2 that I recently downloaded (db-derby- already has the
execute bit set in all the files. Is that going to be the usual practice? If so, this subsection
may not be needed. On the other hand, this version of 10.2 still puts the commands in DERBY_HOME/frameworks/embedded/bin
and DERBY_HOME/frameworks/NetworkServer/bin -- and the UNIX scripts still have the .ksh extension
-- so it obviously doesn't reflect future practice. 

The rest of the files look just fine -- admirable job on a rather hairy assignment.

There's one more question that I wonder if I should file a separate bug for. The new book,
workingwithderby, has a conrefs file that doesn't include the "prod" settings that the other
ones have. Instead it just hardcodes "Derby" and "DERBY_HOME" and whatnot into the text files.
I don't know how important this is. If you think it's worth doing, I can take it on. The books
should probably be consistent.

> Update Getting Started to include instructions on setting JAVA_HOME variable.
> -----------------------------------------------------------------------------
>                 Key: DERBY-1223
>                 URL: http://issues.apache.org/jira/browse/DERBY-1223
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions:
>            Reporter: Andrew McIntyre
>         Assigned To: Laura Stewart
>            Priority: Minor
>         Attachments: derby1223.diff, Derby1223_html.zip, Derby1223_ProposedChanges.txt
> As of the fix for DERBY-1082, the scripts were made consistent to require setting DERBY_HOME
(or DERBY_INSTALL) and JAVA_HOME. The documentation on setting up your environment in the
Getting Started guide should be updated to reflect that these variables should be set. 

This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message