Bug 132233 - Conflicting documentation for Setting the Java VM using -vm
Summary: Conflicting documentation for Setting the Java VM using -vm
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.1   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.3 M1   Edit
Assignee: Platform-Doc-Inbox CLA
QA Contact:
URL: http://help.eclipse.org/help31/index....
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2006-03-16 14:42 EST by Tim Fletcher CLA
Modified: 2006-06-12 17:15 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Tim Fletcher CLA 2006-03-16 14:42:50 EST
In the "Workbench User Guide", "Tasks", "Running Eclipse" topic (http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse.platform.doc.user/tasks/running_eclipse.htm) there is conflicting documentation for setting the VM to use.

The "Setting the Java VM using -vm" paragraph states:

"It is recommended that you explicitly specify which Java VM to use when running Eclipse. This is achieved with the -vm command line argument (for example, -vm c:\jre\bin\javaw.exe). If you don't use -vm, Eclipse will use the first Java VM found on the O/S path. When you install other products, they may change your path, resulting in a different Java VM being used when you next launch Eclipse."

In the very next paragraph "Advanced Topics in Running Eclipse" the "-vm VMPath" argument in the table is described to be:

"The location of Java Runtime Environment (JRE) to use to run the Eclipse platform. If not specified, the JRE is at jre, sibling of the Eclipse executable. Relative paths are interpreted relative to the directory that eclipse was started from."

The reader is left to wonder whether the JRE in the sibling directory to eclipse, jre, is used if the -vm arguement is ommitted or if the JRE is used selected by the first Java VM found in the O/S path as stated in the earlier section. Could Eclipse.org please clarify?
Comment 1 John Arthorne CLA 2006-06-08 11:12:53 EDT
Fixed.  Both statements are actually true.  The launcher does search for a jre in the directory called "jre" as a sibling of the executable.  If not found there, it will look on the OS path.  This detail wasn't particularly relevent to the "Setting the Java VM" paragraph, but I have added the complete details in the "Advanced Topics" section.
Comment 2 John Arthorne CLA 2006-06-12 17:15:54 EDT
Moving to new M1 milestone