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 "Andrew McIntyre (JIRA)" <de...@db.apache.org> on 2006/04/17 22:39:20 UTC
[jira] Created: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
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
Type: Improvement
Components: Documentation
Versions: 10.2.0.0
Reporter: Andrew McIntyre
Priority: Minor
See DERBY-1082. The affected file is src/getstart/tgssetupjavaenvir.dita.
--
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
Re: [jira] Commented: (DERBY-1223) Update Getting Started to include instructions on setting JAVA_HOME variable.
Posted by Laura Stewart <sc...@gmail.com>.
Thanks Andrew I will make these changes and post a formal patch,
probably Monday morning.
Laura
On 8/18/06, Andrew McIntyre (JIRA) <de...@db.apache.org> wrote:
> [ 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
>
>
>
--
Laura Stewart
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12433238 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
I think the environment variables should not have the $ in front of them unless it is being used in an example. Their capitalization should be enough to distinguish their purpose in the text.
cgsinstallingderby: I prefer just "distribution". Also, I think that "snapshot packages" should become "prerelease snapshots." The use of the word package after "bin, lib, and src" seems like correct usage, though.
tgssetupjavaenvir: agreed, if you can run sysinfo, then java is properly set up.
cgsusingtoolsutils: tools = ij, dblook, sysinfo. Utilities is used in the docs to refer to the jar and import/export system procedures, although there are other system procedures that are just as utilitarian and are not referred to as utilities. :-) scripts = any shell or batch file.
I think getting started needs to only mention the tools. Considering the content, the title should probably be something like "Using the included scripts to start the Derby tools," although that could probably be worded better. Actually, I think the second sentence, "Derby's utilities include..." should be removed, along with the later references to 'utiliies,' as it's unnecessary to mention them here.
For the last two comment, "if the variable is empty or not set" would be correct, but as for whether the section on chmodding the files is even necessary, I actually don't think so, since I just checked both the bin and zip distributions on a Linux box, and the execute bit was set for all of the files after unpacking them. So, I think it can be removed.
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, Derby1223_html.zip, derby1223_html2.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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Attachment: derby1223_2.diff
derby1223_html2.zip
The diff and html files added here are updated based on the comments posted so far,
but these files are NOT ready to be committed.
I need answers to the questions that I added in an earlier post and to the questions that I have below.
Questions:
File = tgssetupjavaenvir
I am not sure that I have all of the steps documented correctly. Please review them carefully.
I used choice tables to more clearly distinguish between UNIX and Windows commands. Unfortnately, the
spacing before and after the choice tables is nonexistant. Is this something that we can change in the
DITA toolkit?
File = cgsusingtoolsutils
The title refers to tools AND startup utilites. Are there really 2 sets of things we are describing
here? If not we should change the title.
File = tgs26250
The comments to update this file are not very clear. And I have had a difficult time with this topic. It seems very disjointed to me. I think part of that stems from using several terms for the same thing (tools, utilities, programs). I realize that there are scripts that are run to launch a program and that these scripts have the same name as the program (ij for example). But we need to be consistent in the terms that we use - not only in this file, but in all of the files.
In the first patch there was a series of bullets that were options for the user to choose from. The first option was to include DERBY_HOME in the CLASSPATH by using the "SET CLASSPATH" command. The comments leave me with no place to put this info. Do you really mean that the command should not be included?
One of the comments asked that the text about setting the JAVA_HOME environment variable in the PATH be added to this file. I am not sure that it belongs here. And it did not seem to fit in with the steps for setting the classpath manually (I am assuming that CLASSPATH and PATH are 2 separate environment variables). Looking at the structure of the Getting Started Guide http://db.apache.org/derby/docs/dev/getstart/
we might want to create a new topic in the following section that describes setting the JAVA_HOME environment variable... unless I have missed some connection here. Please advise.
Manually setting environment variables and paths
Set the DERBY_INSTALL environment variable
Set the classpath
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, Derby1223_html.zip, derby1223_html2.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ 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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12429130 ]
Laura Stewart commented on DERBY-1223:
--------------------------------------
It would be helpful if you answered the questions that are in the txt file that includes the proposed changes.
https://issues.apache.org/jira/browse/DERBY-1223
> 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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Derby Info: [Patch Available]
> 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.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
[jira] Resolved: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart resolved DERBY-1223.
----------------------------------
Resolution: Fixed
Derby Info: (was: [Patch Available])
Changing the status of this patch to Resolved.
Waiting to close this patch until Rick merges it into the 10.2 trunk
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, derby1223_4.diff, derby1223_5.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.zip, derby1223_html4.zip, derby1223_html5.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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Attachment: Derby1223_ProposedChanges.txt
I need more info about what needs to be changed. Attached a list of the proposed changes
that I can see. Please confirm or comment.
> 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.0.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12429910 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
cgsinstallingderby.html: There is also a lib-debug package with jars built with line number tables to aid in debugging and reporting problems. I'm not sure how to best incorporate this information into the page as it is. A description of what the different packages contain may be in order. e.g.:
"The bin distribution contains scripts, demonstration programs, documentation and the optimized jars available in the lib distribution.
The lib distribution contains an optimized, small footprint set of the Derby jars for deployment.
The lib-debug distribution contains a larger footprint set of the Derby jars that are useful for debugging or reporting issues
The src distribution contains the source files used to create the other distributions mentioned above."
But maybe that is too much information for this page?
cgsusingtoolsutils.html: I'm not sure that this is still relevant:
"Derby utilities include the import, export and database class utilities."
Perhaps this should read:
"Some Derby utilities exist as system procedures, including the import and export of external files. These system procedures can be called through ij."
And maybe include a reference to the import/export system procedures in the reference manual. I think "database class utilities" refers to functionality that no longer exists, so it should probably be removed.
"The /bin directory contains scripts for running some of the Derby tools and utilities in embedded mode. You can find similar scripts for running tools and utilities for the Network Server in the NetworkServer/bin directory. "
should read:
"The scripts in DERBY_HOME/bin directory default to using the embedded mode. To run these tools against the Network Server, use:
* sysinfo - run 'NetworkServerControl sysinfo'
* ij - set DERBY_OPTS=-Dij.protocol=jdbc:derby://localhost/ and then execute 'ij'
* dblook - call the script with the -d option and the full URL to the Network Server database. For example: dblook -d 'jdbc:derby://localhost/myDB;user=usr;'
rgslib27507.html:
There needs to be an entry for bin/setNetworkServerCP, which "puts the libraries needed to start the Derby Network Server into the classpath."
tgs26250.html:
setNetworkServeCp should be setNetworkServerCP
These three paragraphs:
"The names of the scripts that help with setting the CLASSPATH are: setEmbeddedCP, setNetworkServeCP, and setNetworkClientCP.
You can set the CLASSPATH environment variable in the operating system either temporarily, permanently, or at run time when you start your Java application and the JVM. If you set the environment variable temporarily, you must set it each time that you open a new command window.
In most development environments, it is best to set the operating system's CLASSPATH environment variable temporarily. Derby provides some scripts to help you set your classpath quickly. These scripts are located in the bin directory or the NetworkServer/bin directory. To set the class path temporarily, run a script every time you open a new command window."
should be combined to something like:
"You can set the CLASSPATH environment variable in the operating system either temporarily, permanently, or at run time when you start your Java application and the JVM. If you set the environment variable temporarily, you must set it each time that you open a new command window. In most development environments, it is best to set the operating system's CLASSPATH environment variable temporarily. Derby provides some scripts in the DERBY_HOME/bin directory to help you set your classpath quickly. These scripts are named: setEmbeddedCP, setNetworkServerCP, and setNetworkClientCP. To set the class path temporarily, run one of these scripts every time you open a new command window."
As for the bullet points, I think the first one should be unbulleted, and made to read "To set your CLASSPATH so that it includes the derby.jar and derbytools.jar files, you can use the setEmbeddedCP script, or set the CLASSPATH variable manually as follows:" Then the next bullet points follow underneath this heading to demonstrate how to run sysinfo or ij without the scripts. The last bullet point should probably be unbulleted as a demonstration of how to specify the classpath directly on the command line.
tgssetupjavaenvir.html:
"You need to set the environment variables so that the JVM and Java applications run correctly" should be "You need to set some environment variables so that the scripts included with the Derby bin distribution run correctly." Remove the next line about PATH.
The rest of this page should be structured as follows:
* set DERBY_HOME - include the content formerly from tgs36360 mentioned by Kim.
* set JAVA_HOME - keep the first two sentences and the first set of examples. The third sentence should move elsewhere. The text after the first set of examples is incorrect and should be removed.
* I don't think bullet 3 needs to be here. Adding JAVA_HOME/bin to the path should probably move to the page about setting the classpath manually, since having the java executable on the path is important in that regard, but not for running the scripts.
* need to add a section about adding DERBY_HOME/bin to the path so that the scripts can be executed from any directory.
* bullet 4 is correct if the above section is added.
The scripts need to have the DERBY_HOME and JAVA_HOME properly set, and DERBY_HOME/bin added to the path, if the user wants to be able to execute the scripts from any location on their system from their current shell environment.
...
I'm sure I've missed something or made something more unclear than it already was. Please don't hesitate to ask for clarification about any of these comments. This review has made it clear that the Getting Started guide was in really bad shape. Thank you for helping to make it better.
> 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.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12433337 ]
Laura Stewart commented on DERBY-1223:
--------------------------------------
Wait for another patch. I want to fix these ;-) I'll do this tomorrow.
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Andrew McIntyre updated DERBY-1223:
-----------------------------------
Description: 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. (was: See DERBY-1082. The affected file is src/getstart/tgssetupjavaenvir.dita.)
> 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.0.0
> Reporter: Andrew McIntyre
> Priority: Minor
>
> 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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Mike Matrigali (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Mike Matrigali updated DERBY-1223:
----------------------------------
Fix Version/s: 10.2.1.0
> 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
> Fix For: 10.2.1.0
>
> 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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12428578 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
The attached list of proposed changes looks good to me. It's hard to tell if any further changes will be necessary, but the proposed changes appear to cover all the bases. If you have the time, please put together a patch with these changes. Any further changes that are necessary can be handled in the review of that patch.
> 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.0.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12433265 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
Wow, this is already a great improvement. Some further comments:
cgsinstallingderby: "You will also find information on accessing the active source distributions for Derby." should probably be "You will also find information on how to use Subversion to access the Derby source code currently in development.".
tgssetupjavaenvir: 1. "Set the DERBY_HOME environment variable." should maybe be "Set the DERBY_HOME environment variable to the location where you extracted the bin distribution." The second sentence is confusing and maybe should be removed, since it looks like it actually belongs in number 3. Third sentence needs a space before DERBY_HOME.
3. Unix example should be export PATH="$DERBY_HOME/bin:$PATH"
Remove #4.
cgsusingtoolsutils: now that i can see the edited page, I think the title could stay as is if we include a reference to where the 'utilities' are documented. For example, if the first paragraph ended with this sentence: "Instructions on how to use these system procedures are included in the Derby Tools and Utilities Guide and the Derby Reference Manual" I think import/export is something that even new, novice users will probably be interested in and so it might be good to point them to where import/export is documented.
I think the following paragraph is confusing and should be removed along with the note about the Unix chmod business: "The scripts have descriptive names such as sysinfo or ij. Like the classpath scripts, these scripts end with different extensions depending on your environment. Windows scripts have a .bat extension. You might need to modify these scripts for the tools and utilities to run properly on Windows and UNIX operating systems." This can be replaced with something simple like "The DERBY_HOME/bin directory contains scripts to help you start the Derby tools and to help you set up your classpath. "
Organizationally, maybe it then makes sense to make tgs26250 change from "Manually setting the classpath" to "Setting your classpath" or "Using the classpath-setting scripts" and be a subsection of this topic, since that page does talk about using the classpath setting scripts?
tgs26250: I think this page needs to be refocused around the classpath setting scripts. Everything starting with the Tip section until the end of the page can be removed, since it's confusing and the idea is getting people off the ground and explaining to them what the scripts do, not to have them jumping through hoops with their environment. :-)
I think the first sentence can be removed, and then the first two paragraphs combined. "a CLASSPATH environment variable" should be "the CLASSPATH environment variable."
" In most development environments, it is best to temporarily set the CLASSPATH environment variable for the operating system." I think "for the operating system" should be something like "in the command-line shell where you are entering commands". "provides some scripts" should be "provides three scripts".
think what would be more useful instead is a description of what the three classpath scripts do:
"* setEmbeddedCP adds derby.jar and derbytools.jar to the classpath, for using the database engine in embedded mode.
* setNetworkServerCP adds derby.jar and derbynet.jar to the classpath, so that you can start the network server.
* setNetworkClientCP adds derbyclient.jar and derbytools.jar to the classpath, so that you can access databases using the network client.
To see the classpath that the script sets, issue the command "echo $CLASSPATH" (Unix) or "echo %CLASSPATH%" (Windows) after running the script"
As a general note, it would probably be a good idea to mention derbyrun.jar in here somewhere, maybe the sysinfo and ij pages should include an example of invoking each tool using derbyrun.jar. It would also be useful to talk about using the scripts to start and stop the network server. Both of those are outside of the scope of this issue, so I'll add them to the Getting Started doc review wiki page.
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, Derby1223_html.zip, derby1223_html2.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
[jira] Assigned: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart reassigned DERBY-1223:
------------------------------------
Assignee: Laura Stewart
> 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.0.0
> Reporter: Andrew McIntyre
> Assigned To: Laura Stewart
> Priority: Minor
>
> 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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12433200 ]
Laura Stewart commented on DERBY-1223:
--------------------------------------
I have some additional questions for you:
General -
Should the environment variables have the "$" in front of them? For example $DERBY_HOME.
File = cgsinstallingderby
Here we use the term "distribution", "package", and "distribution package". It seems to me that they refer to the same thing. It would be best if we stuck to just one term. What is most accurate?
File = tgssetupjavaenvir
Do we really need to issue both java -version and sysinfo? The way that the text is currently written, it seems that sysinfo provides the version of the JVM.
File = cgsusingtoolsutils
The title refers to tools AND startup utilites. Are there really 2 sets of things we are describing here? If not we should change the title.
In some places we use different words to describe the same thing "tools" "utilities" "scripts". We should stick with one word if all of these are really referring to the same thing. What is the most appropriate word?
In the note a the bottom of this topic, it mentions "if the variable is empty". Shouldn't it say "if the variable is empty or not set" ?
In Kim's comments she mentions that when she downloaded Derby, the execute bit was already set in all of the files. If that is the setting when Derby is installed, then perhaps the section on setting the bit is unnecessary?
> 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
> Fix For: 10.2.1.0
>
> 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
[jira] Closed: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Andrew McIntyre closed DERBY-1223.
----------------------------------
> 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.6
> Reporter: Andrew McIntyre
> Assigned To: Laura Stewart
> Priority: Minor
> Fix For: 10.2.1.6
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, derby1223_4.diff, derby1223_5.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.zip, derby1223_html4.zip, derby1223_html5.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12433332 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
Thanks, Laura, this is getting very close. Comments on the _3 patch:
cgsinstallingderby: the use of <filepath> blocks has caused the formatting of the last bulleted list to be off. This is probably a bug in the DITA toolkit's transfomations for <filepath>s. Maybe <codeph> should continue to be used here until we can figure out exactly what is going on.
tgssetupjavaenvir: The fifth bullet point was also removed. Was that intentional? If so, it's ok, since if a user is following along in the manual, running sysinfo is only a couple of pages away. The Unix example for #3 contains an extra equals after DERBY_HOME: export PATH="$DERBY_HOME=/bin:$PATH". With the description for #3, maybe the sentence after the examples is unnecessary? I'll leave that decision up to you. At the end "For more information on scripts," should probably be "For more information on the scripts included in the bin distribution"?
cgsusingtoolsutils: looks great, much improvement. Several small issues: second paragraph: "Use the Derby scripts" should maybe be "You can use"? Extra period in the third paragraph before "For example". Last sentence: "In discussing these tools in embedded mode, the directory is referred to as the /bin directory unless stated otherwise." I think "DERBY_HOME/bin" is used elsewhere, but maybe we don't even need to mention it? How about something like: "The use of the Derby scripts to launch the tools in the following examples use the embedded mode of the Derby database engine."
cgsusingsysinfo: sorry I missed this before, "After you set the DERBY_HOME/bin directory in your PATH" should probably be "After you put the DERBY_HOME/bin directory into your PATH"? Similar wording may be desirable for the first part of the 'Running ij' page.
Feel free to pass on anything with a question mark up there. In fact, I could even fix the filepath -> codeph and the Unix example in tgssetupjavaenvir and commit this patch as-is. Let me know if you'd like to address any of the other items I brought up and I'll wait for another patch, or if you'd prefer I fix those two issues and commit as-is.
I'll look into the formatting for the choice tables. I agree that they could use more space. I don't think that should be a hindrance to getting this patch committed, though.
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12432926 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
Any direct reference to the environment variable should be capitalized, any reference to the general concept of classpath can be lowercase. So, in examples or in the phrase "CLASSPATH environment variable" it should remain capitalized, in all other cases it can be lowercase.
The problems I see in the file currently are that "class path" should become "classpath" and in the first bullet point "CLASSPATH" should either be "CLASSPATH environment variable" or "classpath".
> 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
> Fix For: 10.2.1.0
>
> 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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Kim Haase (JIRA)" <de...@db.apache.org>.
[ 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:
cgsusingtoolsutils.html:
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-10.2.1.0-bin) 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: 10.2.1.0
> 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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12434025 ]
Andrew McIntyre commented on DERBY-1223:
----------------------------------------
Committed 1223_5 patch with revision 442401. Thank you, Laura! This is a great improvement to the Getting Started guide.
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, derby1223_4.diff, derby1223_5.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.zip, derby1223_html4.zip, derby1223_html5.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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Attachment: derby1223.diff
Derby1223_html.zip
Attached a patch and html zip file for these doc updates.
Several questions:
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.
2) In the filetgssetupjavanvir, I am not certain that I acturately captured all of the changes that you requested.
The files updated for this issue are:
Filename Title Summary of update
tgssetupjavaenvir Setting up your environment Updated script info
tgsrunningij Running ij Added DERBY_HOME to the path
tgs26250 Manually setting the classpath Updated script info, updated title
rgslib27507 Scripts included with Derby Updated script info, added indexes, updated title
cgsusingtoolsutils Using the Derby tools and startup utilities Updated script info, added indexes, & updated title
cgsusingsysinfo Using the sysinfo tool Updated script info, updated title
cgsinstallingderby Installing Derby Updated script info, added indexes
tgs36360 Set the DERBY_HOME environment variable Deleted file
cgsmanuallysetting Manually setting environment variables and paths Deleted file
getstartderby map file for getting started guide Updated map
gsconrefs conrefs for getting started guide Changed conrefs for DERBY_HOME
adminconrefs conrefs for admin guide Changed conrefs for DERBY_HOME
devconrefs conrefs for dev guide Changed conrefs for DERBY_HOME
refconrefs conrefs for ref manual Changed conrefs for DERBY_HOME
toolsconrefs conrefs for tools Changed conrefs for DERBY_HOME
tunconrefs conrefs for tuning guide Changed conrefs for DERBY_HOME
pt_BR/adminconrefs conrefs for BR Portuguese admin guide Changed conrefs for DERBY_HOME
pt_BR/refconrefs conrefs for BR Portuguese ref manual Changed conrefs for DERBY_HOME
pt_BR/gsconrefs conrefs for BR Portuguese getting started guide Changed conrefs for DERBY_HOME
> 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.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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Attachment: derby1223_html3.zip
derby1223_3.diff
Okay, I updated the files and have attached a patch and an html.zip file (#3).
I did put the "Setting the classpath" file under the "Using the tools and utilities".
And I updated the ditamap file to reflect the links and add a few more links.
I am concerned that we mention that you can set the classpath permanently and at run time
but we don't discuss or point them to how to do this. I realize that we are trying to get people
up and running quickly, but we might want to add a reference...
Finally, can you fix the spacing around the choice tables (see tgssetupjavaenvir.html)
Choise tables are very useful but we need a blank line before and after. Is that something that the
CSS file or DTD file controls?
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Attachment: derby1223_4.diff
derby1223_html4.zip
Andrew -
I updated the files per your comments. I would appreciate it if you can look into the spacing issue
around the choice tables. I expect to use them quite a lot in the Derby documentation.
Please let me know if you have any further comments/corrections !
Laura
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, derby1223_4.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.zip, derby1223_html4.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
[jira] Commented: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12432905 ]
Laura Stewart commented on DERBY-1223:
--------------------------------------
Andrew - in file tgs26250, please specify when the text is talking about classpath in general and when it is referring to the CLASSPATH environment variable. I need to know this for the proper capitaliztion of "classpath".
> 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
> Fix For: 10.2.1.0
>
> 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
[jira] Updated: (DERBY-1223) Update Getting Started to include
instructions on setting JAVA_HOME variable.
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1223?page=all ]
Laura Stewart updated DERBY-1223:
---------------------------------
Attachment: derby1223_5.diff
derby1223_html5.zip
Sorry, make a mistake and am resubmitting the patch.
The current patch and html files are #5
> 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
> Fix For: 10.2.1.0
>
> Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, derby1223_4.diff, derby1223_5.diff, Derby1223_html.zip, derby1223_html2.zip, derby1223_html3.zip, derby1223_html4.zip, derby1223_html5.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