[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12429139 ] Andrew McIntyre commented on DERBY-1223: ----------------------------------------
Sorry, I thought it would be easier to just review the proposed changes, but now I see that this section needs some reworking. tgssetupjavanvir: This page needs a complete overhaul, and should probably be merged with the content from tgs36360 and the number 2 item from cgsusingtoolsutils. The title should probably be "Setting up your environment" and should include instructions for setting DERBY_HOME, JAVA_HOME, and adding $DERBY_HOME/bin to PATH. For JAVA_HOME, something like this should sufficient: "You need to set your JAVA_HOME environment variable so the scripts can find the JVM and Java applications run correctly. JAVA_HOME should be set to the installation location of your JVM. For example: set JAVA_HOME=C:\Program Files\Java\j2se1.4.2_05 export JAVA_HOME=/usr/j2se If you have more than one JVM installed, you can use the JAVA_HOME variable to switch between JVMs by updating the value with the installation location of any supported JVM. You can then also run java commands directly by adding JAVA_HOME to your PATH. For example: set PATH=%JAVA_HOME%/bin;%PATH% export PATH="$JAVA_HOME/bin:$PATH" The parts about setting PATH should come after instructing the user to add $DERBY_HOME to the path: "It is important for the success of your installation because the PATH variable enables your operating system to find the scripts from any directory. To check that the JAVA_HOME and DERBY_HOME variables have been set correctly and that $DERBY_HOME/bin has been added to the PATH environment variable correctly, in a command window, type the following: sysinfo If the environment variables are set correctly, Derby's sysinfo command will print information about your JVM and the version of Derby you have installed to the console." rgslib27507: i think it's ok to leave the DERBY_HOME off here, but it may be clearer if it is included. The new Unix scripts in /bin do not have an extension. Please fix the paths to the scripts, though. e.g. frameworks/embedded/bin/ij -˘> bin/ij and remove the duplicate ij / sysinfo / dblook entries after that change. tgs26250: The title should change to "Manually setting the classpath." This page should mention that the scripts will set up their own classpath for running the tools, but to call the tools directly using Java and not using the scripts, they will need to set the classpath. Change frameworks/*/bin -> bin. Probably a good idea to mention the names of the scripts that help with setting classpath, setEmbeddedCP, setNetworkServeCP, setNetworkClientCP. It might be useful to have an example that uses the -cp option of java. Something along the lines of: "The classpath can also be specified directly on the command-line. For example, on Windows: java -cp %DERBY_HOME%/lib/derbytools.jar org.apache.derby.tools.sysinfo" tgs36360: This page should be merged with tgssetupjavanvir as mentioned above. cgsmanuallysetting: This page should be removed. tgsrunningij: Yes, include $DERBY_HOME with the /bin here. No other changes. cgsusingsysinfo: Same as above. cgsusingtoolsutils: Change frameworks/*/bin -> bin. ij.ksh -> ij. Unix scripts no longer have an extension. The numbered two point should move to the "setting up your environment page" and refer to $DERBY_HOME/bin. The number 1 point here should then be unnumbered, obviously and read something like: "In order to use the script files to run the tools and utilities, it may be necessary to turn on the execute bit for the script files: chmod +x $DERBY_HOME/bin/* Note: be sure that the environment variable $DERBY_HOME is set in your current shell by executing 'echo $DERBY_HOME' and validating that it is set to the location of your Derby installation. If the variable is empty, the command that will actually be executed is 'chmod +x /bin/*.' While this is unlikely to damage your system, since the contents of /bin on most Unix systems are all executable, it will not have the desired effect of making the Derby scripts executable." Also: cgsinstallingderby should mention the /bin directory instead of frameworks > 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: 10.2.1.0 > Reporter: Andrew McIntyre > Assigned To: Laura Stewart > Priority: Minor > Attachments: 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
