Bug 15889 - API: BootLoader.getOS references OS types
Summary: API: BootLoader.getOS references OS types
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Resources (show other bugs)
Version: 2.0   Edit
Hardware: PC All
: P3 normal (vote)
Target Milestone: 2.0 M6   Edit
Assignee: DJ Houghton CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2002-05-13 14:46 EDT by DJ Houghton CLA
Modified: 2002-05-20 21:48 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 DJ Houghton CLA 2002-05-13 14:46:40 EDT
The javadoc for BootLoader.getOS makes reference to the different OS types 
that it may return, while getNL, getOSArch, and getWS do not.

Recommend that we change the comment to be similar to those other methods and 
reference the knownOSValues method.

/**
 * Returns the string name of the current operating system for use in finding
 * files whose path starts with <code>$os$</code>.  <code>OS_UNKNOWN</code> is
 * returned if the operating system cannot be determined.  
 * The value may indicate one of the operating systems known to the platform
 * (as specified in <code>knownOSValues</code>) or a user-defined string if
 * the operating system name is specified on the command line.
 *
 * @return the string name of the current operating system
 * @see #knownOSValues
 * 
 */
Comment 1 DJ Houghton CLA 2002-05-20 21:48:17 EDT
Fixed and released.