Bug 137993 - [doc] org.eclipse.osgi/.options poorly documented
Summary: [doc] org.eclipse.osgi/.options poorly documented
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: Framework (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.2 RC3   Edit
Assignee: equinox.framework-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation, polish
Depends on:
Blocks:
 
Reported: 2006-04-21 12:43 EDT by John Arthorne CLA
Modified: 2006-05-01 13:12 EDT (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description John Arthorne CLA 2006-04-21 12:43:31 EDT 
Build: N20060421

The .options file for org.eclipse.osgi has many debug flags that have no documentation. The convention is to add a line or two comment directly in the .options file above each option to describe its purpose.  As it is, a lot of digging through implementation code is needed to figure out what each option does.
Comment 1 Thomas Watson CLA 2006-04-21 13:49:44 EDT 
polish item for RC3.
Comment 2 Thomas Watson CLA 2006-05-01 11:39:47 EDT 
Added some more comments to the .options file.
Comment 3 John Arthorne CLA 2006-05-01 12:01:37 EDT 
Actually, the option I was really looking for when I logged this was:

org.eclipse.osgi/debug/bundleTime=true

This flag is very useful as a way to get quick and dirty timing information for bundle startup.  You seem to have deleted this option entirely from the .options file, although the flag still works.
Comment 4 Thomas Watson CLA 2006-05-01 13:12:12 EDT 
Opps.  I got a bit eager when removing unused flags and removed that one by accident.  What are the odds that is the one you wanted!!  I added it back.  Thanks John.