The following is an example of the Model-Fragment header:
@@ -492,12 +495,12 @@
The apply attribute is optional and defaults to always. It can have the following values:
-
If the location specified in step 5 is <install>,
the installer copies all the files in the <JRE>, <platform>, <product>,
and <product plug-ins> directories into <install>.
| Input file | -Installed file | +Input file | +Installed file |
<JRE>/* |
- <install>/eclipse/* |
+ <JRE>/* |
+ <install>/eclipse/* |
<product head>/* |
- <install>/* |
+ <product head>/* |
+ <install>/* |
<product body>/* |
- <install>/* |
+ <product body>/* |
+ <install>/* |
<platform>/* |
- <install>/* |
+ <platform>/* |
+ <install>/* |
The marker file created in step 8 is <install>/eclipse/.eclipseproduct
@@ -398,14 +405,14 @@
If the location specified in step 5 is <install>,
the installer copies all the files in the <extension> directory
into <install> in step 11.
| Input file | -Installed file | +Input file | +Installed file |
<extension>/* |
- <install>/* |
+ <extension>/* |
+ <install>/* |
For step 7, any Eclipse product might be a candidate. Eclipse-based product diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html index 3298b552050..ffbb6d1ba0a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html @@ -1,13 +1,12 @@ - +
- - - + +Eclipse provides a number of strategies for supporting multi-user installs. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/naming.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/naming.html index d4722f3c445..ed039d6c3a3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/naming.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/naming.html @@ -1,11 +1,10 @@ - +
- - - + +Naming conventions and guidelines for the Eclipse Platform:
Java's naming guidelines state
Class names should be nouns, in mixed case with the first letter @@ -157,8 +154,7 @@follow the common practice of ending in "Exception". -
-Methods
+Methods
Java's naming guidelines state
Methods should be verbs, in mixed case with the first letter @@ -175,8 +171,7 @@hasX()). -
-Variables
+Variables
Java's naming guidelines state
Except for variables, all instance, class, and class constants @@ -195,8 +190,7 @@
float myWidth;(Note: we are no longer following the convention that prefixes non-constant field names with "f", such as "fWidget".)
--Constants
+Constants
Java's naming guidelines states
The names of variables declared class constants and of ANSI @@ -206,8 +200,7 @@-
static final int MAX_WIDTH = 999;
static final int GET_THE_CPU = 1;-Plug-ins and Extension Points
+Plug-ins and Extension Points
All plug-ins, including the ones that are part of the Eclipse Platform, like the Resources and Workbench plug-ins, must have unique identifiers following the same naming pattern as Java packages. For example, workbench diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html index 5209a5c5f2e..9b700c282e7 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html @@ -1,14 +1,23 @@ - +
- - + - +Map of platform plug-ins + @@ -20,8 +29,7 @@Map of Platform Plug-ins
The following table shows which API packages are found in which plug-ins. This table is useful for determining which plug-ins a given plug-in should include as prerequisites. -- +
- -
API Package Required plug-in id @@ -141,7 +149,7 @@Map of Platform Plug-ins
org.eclipse.core.runtime -
org.eclipse.equinox.registry
org.eclipse.equinox.common[1] +[1] org.eclipse.core.runtime.dynamichelpers
@@ -380,7 +388,7 @@Map of Platform Plug-ins
org.eclipse.jface.wizard
org.eclipse.jface.wizard.imagesorg.eclipse.jface -[3] +[3] org.eclipse.jface.contentassist
@@ -402,7 +410,7 @@Map of Platform Plug-ins
org.eclipse.jface.text.templates (split)
org.eclipse.jface.text.templates.persistenceorg.eclipse.jface.text -[4] +[4] org.eclipse.jface.text (split)
@@ -413,7 +421,7 @@Map of Platform Plug-ins
org.eclipse.text.edits
org.eclipse.text.undoorg.eclipse.text -[4] +[4] @@ -500,7 +508,7 @@ Map of Platform Plug-ins
org.eclipse.swt.program
org.eclipse.swt.widgetsorg.eclipse.ui -[5] +[5] org.eclipse.swt.ole.win32 @@ -550,7 +558,7 @@Map of Platform Plug-ins
org.eclipse.ui.editors.text.templates
org.eclipse.ui.texteditor (split)org.eclipse.ui.editors -[7] +[7] org.eclipse.ui.forms
@@ -603,7 +611,7 @@Map of Platform Plug-ins
org.eclipse.ui.views
org.eclipse.ui.wizards- org.eclipse.ui.workbench[8,9] +[8,9] org.eclipse.ui (split)
@@ -624,7 +632,7 @@Map of Platform Plug-ins
org.eclipse.ui.wizards.datatransfer
org.eclipse.ui.wizards.newresource- org.eclipse.ui.ide[9] +[9] org.eclipse.ui.intro.config
@@ -657,7 +665,7 @@Map of Platform Plug-ins
org.eclipse.ui.texteditor.spelling
org.eclipse.ui.texteditor.templatesorg.eclipse.ui.workbench.texteditor -[7] +[7] org.eclipse.unittest.launcher
@@ -683,9 +691,8 @@Map of Platform Plug-ins
Note 1: +
Note 1: The content of the org.eclipse.core.runtime package is provided by the following plug-ins:
org.eclipse.equinox.common- @@ -695,25 +702,25 @@
org.eclipse.equinox.registryMap of Platform Plug-ins
plug-in that combines all APIs present in this package. However, to improve modularity, plug-ins are encouraged to list only the required prerequisites. -Note 3: Plug-ins needing access to the JFace API must list
org.eclipse.ui+Note 3: Plug-ins needing access to the JFace API must list
-org.eclipse.uias a prerequisite plug-in.org.eclipse.uire-exports API from the JFace plug-in. Theorg.eclipse.jfaceplug-in should never be explicitly listed as a prerequisite.Note 4: Some of the JFace text packages are split between the
org.eclipse.jface.text+Note 4: Some of the JFace text packages are split between the
-org.eclipse.jface.textand theorg.eclipse.textplug-ins.Note 5: Plug-ins needing access to the SWT API must list
org.eclipse.uias +Note 5: Plug-ins needing access to the SWT API must list
-org.eclipse.uias a prerequisite plug-in.org.eclipse.uire-exports API from the SWT plug-in. Theorg.eclipse.swtplug-in should never be explicitly listed as a prerequisite.Note 7: The
org.eclipse.ui.texteditorpackage is split between the +Note 7: The
-org.eclipse.ui.texteditorpackage is split between theorg.eclipse.ui.editorsand theorg.eclipse.ui.workbench.texteditorplug-ins.Note 8: Plug-ins needing access to the Workbench UI API must list
org.eclipse.ui+Note 8: Plug-ins needing access to the Workbench UI API must list
-org.eclipse.uias a prerequisite plug-in.org.eclipse.uire-exports API from theorg.eclipse.ui.workbenchplug-in. Theorg.eclipse.ui.workbenchplug-in should never be explicitly listed as a prerequisite.Note 9: Some of the UI packages are split between the
org.eclipse.ui+Note 9: Some of the UI packages are split between the
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html index 0e2e81c90e3..857dae109ee 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html @@ -1,13 +1,12 @@ - + - - + +org.eclipse.uiand theorg.eclipse.ui.ideplug-ins.The dropins folder and supported file layouts diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/platform-scheme-uri.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/platform-scheme-uri.html index 24b0340e480..9025d32be32 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/platform-scheme-uri.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/platform-scheme-uri.html @@ -1,13 +1,17 @@ - + - - +Generating Metadata +Platform URLs in Eclipse
@@ -23,37 +27,37 @@Platform URLs in Eclipse
There are a few ways to work with the "platform" scheme:
-+
-
platform:/resource +- platform:/resource It is used to identify a resource located in the workspace. The next path segment after "resource" should be the name of a project, which can be followed by the folder and/or file we want to locate. platform:/plugin It +
- platform:/plugin It is used to locate a resource available in a plug-in/bundle. One really cool thing about this one is that it doesn't really matter if this resource is available in a directory or in a jar file. It also doesn't matter if the bundle is installed in a link folder or in the default directory.
The path segment after "plugin" should be the identifier of the bundle, which can be followed by the path of the resource in the bundle.
platform:/fragment This + - platform:/fragment This one is quite similar to "platform:/plugin", being used to locate fragment resources instead of bundle resources. As you are probably guessing, the segment after "fragment" should be the fragment's identifier. platform:/meta We can + - platform:/meta We can use this to access a bundle's stage location. The path segment after "meta" should be the bundle's identifier, followed by the path of the resource we want to refer to. platform:/config The "config" segment causes the + - platform:/config The "config" segment causes the platform URI to refer to the configuration area of the running Eclipse (usually the eclipse/configuration directory). This can be useful to read the config.ini file, for example. platform:/base This always + platform:/base This always refers to the directory of the Eclipse being executed.
It is interesting to note that, for example,platform:/base/plugins/org.eclipse.mybundle/plugin.xmlandplatform:/plugin/org.eclipse.mybundle/plugin.xmldon't necessarily refer to the same resource. The former is a "pointer" to a plugin.xml file located in a directory diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_archive.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_archive.html index 3b5000464d8..e60a4d9050c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_archive.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_archive.html @@ -1,11 +1,11 @@ - + - - + +Plugin-in Archives diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_dtd.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_dtd.html index 432f441896a..287ccd63e29 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_dtd.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_dtd.html @@ -1,11 +1,11 @@ - + - +Plug-in manifest dtd diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html index 5e31561882c..f048e68083c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html @@ -1,12 +1,12 @@ - + - - + +Plug-in manifest diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html index 84f8876f496..9c336ee2e25 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html @@ -1,16 +1,16 @@ - + - - + +Project description file - + -+
The Project Description File
Description: When a project is created in the workspace, a project description file is automatically generated that describes the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html index 5ec542e2b1f..f238aa18419 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html @@ -1,14 +1,26 @@ - + - - - + +Eclipse runtime options + @@ -20,7 +32,7 @@The Eclipse Runtime Options
the command line arguments are simply short cuts for setting the related System properties. In fact, there are many more System property settings than command line arguments. -Command Line Arguments
+Command Line Arguments
Listed below are the command line arguments processed by various parts of the Eclipse runtime. Many of these values can also be specified using System properties either on the command line using -D VM arguments, by specifying @@ -60,7 +72,7 @@
Command Line Arguments
- -dev [entries] (OSGi)
- equivalent to setting osgi.dev to [entries] or the empty string to simply enable dev mode (i.e., if entries are not specified)
-- -eclipse.keyring <file path> (Equinox)
+- -eclipse.keyring <file path> (Equinox)
- Set to override the location of the default secure storage. If specified, this parameter takes precedence over setting the
@@ -81,7 +93,7 @@ECLIPSE_KEYRINGenvironment variable.Command Line Arguments
- -install <location> (Main)
- equivalent to setting osgi.install.area to <location>
-- --launcher.defaultAction <option> (Executable)
+- --launcher.defaultAction <option> (Executable)
- specifies the default action to take when the launcher is started without any "-" arguments on the command line. Currently the only supported value is "openFile". The "openFile" option tells the @@ -94,7 +106,7 @@
-Command Line Arguments
"Send To" Eclipse.- --launcher.openFile <space separated list of files> (Executable)
+- --launcher.openFile <space separated list of files> (Executable)
- a space separated list of files to pass to the application. This option is typically used to pass a list of files to be opened by an Eclipse application. This option requires SWT in order to fire the necessary SWT_OPENDOC event for @@ -125,7 +137,7 @@
-Command Line Arguments
secondary thread. This should used if a swing application is being run. SWT will NOT work if this option is specified.- --launcher.timeout <value> (Executable)
+- --launcher.timeout <value> (Executable)
- a timeout value for how long the launcher should spend trying to communicate with an already running eclipse before the launcher gives up and launches a new eclipse instance. Default is 60 (seconds). @@ -296,148 +308,148 @@
-System Properties
area-
-- eclipse.activateRuntimePlugins
+- eclipse.activateRuntimePlugins
- controls activation of runtime plug-ins. RCP applications not requiring services provided by runtime plug-ins can set this property to "false" to avoid activation of runtime plug-ins on Eclipse startup
-- eclipse.allowAppRelaunch
+- eclipse.allowAppRelaunch
- if set to "true" then the main thread will continue to wait for another application descriptor to be launched after the currently running application has quit. Stopping the system.bundle (i.e. the bundle with a bundle ID equal to zero) will force the main thread to stop waiting for another application to launch. The default value is "false"
-- eclipse.application {-application}
+- eclipse.application {-application}
- the identifier of the application to run. The value given here overrides any application defined by the product (see eclipse.product) being run
-- eclipse.application.launchDefault
+- eclipse.application.launchDefault
- Controls launching the default application automatically once the platform is running. A default application is identified by the eclipse.product or the eclipse.application options. The default value is "true". Setting this property to "false" will prevent the default application from launching automatically. Once the platform is running the main thread will wait for an application to be launched using an application descriptor service.
-- eclipse.application.registerDescriptors
+- eclipse.application.registerDescriptors
- Controls registration of application descriptor services for all installed applications. The default value is "false". If set to "false" only the default application will have an application descriptor service registered. If set to "true" then all installed applications will have an application descriptor service registered.
-- eclipse.appName
+- eclipse.appName
- Allows to set the application name with which Eclipse is registered in the operating system. This option is helpful to distinguish and group Eclipse instances.
-- eclipse.commands
+- eclipse.commands
- a new-line separated list of all command-line arguments passed in when launching Eclipse
-- eclipse.consoleLog
+- eclipse.consoleLog
- if "true", any log output is also sent to Java's System.out (typically back to the command shell if any). Handy when combined with -debug
-- eclipse.debug.startupTime
+- eclipse.debug.startupTime
- the time in milliseconds when the Java VM for this session was started
-- eclipse.ee.install.verify
+- eclipse.ee.install.verify
- if set to "true" then the framework will check the required execution environment at bundle install time. The default value is "false".
-- eclipse.exitOnError
+- eclipse.exitOnError
- if set to "true" then the platform will exit if an unhandled error occurs. The default value is "true".
-- eclipse.ignoreApp
+- eclipse.ignoreApp
- if set to "true" then the main launching thread will not start the default application and will proceed in shutting down the platform and exiting. The default value is "false". This is different than the eclipse.application.launchDefault option because the main thread will not wait for an application descriptor service to be launched.
-- eclipse.log.level
+- eclipse.log.level
- sets the level used when logging messages to the eclipse log. -
-+
- ERROR - enables logging only ERROR messages.
- WARNING - enables logging of ERROR and WARNING messages.
- INFO - enables logging of ERROR, WARNING and INFO messages.
- ALL - enables logging of all messages (default value)
- eclipse.log.backup.max
+- eclipse.log.backup.max
- the max number of backup log files to allow. The oldest backup log file will be deleted after the max number of backup log files is reached as a result of rotating the log file. The default value is "10". A negative or zero value will cause the default value to be used.
-- eclipse.log.size.max
+- eclipse.log.size.max
- the max size in Kb that the log file is allowed to grow. The log file is rotated when the file size exceeds the max size. The default value is "1000". A negative value will cause the default value to be used. A zero value indicates no max log size.
-- eclipse.noExtensionMunging
+- eclipse.noExtensionMunging
- if "true", legacy registry extension are left as-is. By default such extensions are updated to use the new extension point ids found in Eclipse 3.0.
-- eclipse.noLazyRegistryCacheLoading {-noLazyRegistryCacheLoading}
+- eclipse.noLazyRegistryCacheLoading {-noLazyRegistryCacheLoading}
- if "true", the platform's plug-in registry cache loading optimization is deactivated. By default, configuration elements are loaded from the registry cache (when available) only on demand, reducing memory footprint. This option forces the registry cache to be fully loaded at startup.
-- eclipse.noRegistryCache {-noRegistryCache}
+- eclipse.noRegistryCache {-noRegistryCache}
- if "true", the internal extension registry cache is neither read or written
-- eclipse.pluginCustomization {-pluginCustomization}
+- eclipse.pluginCustomization {-pluginCustomization}
- the file system location of a properties file containing default settings for plug-in preferences. These default settings override default settings specified in the primary feature. Relative paths are interpreted relative to the current working directory for Eclipse itself.
-- eclipse.product {-product}
+- eclipse.product {-product}
- the identifier of the product being run. This controls various branding information and what application is used.
-- eclipse.registry.MultiLanguage {-registryMultiLanguage}
+- eclipse.registry.MultiLanguage {-registryMultiLanguage}
- if "true", extension registry supports translation to multiple languages. By default extension registry provides translation only to the Eclipse locale specified by the osgi.nl.
-- eclipse.service.jobs
+- eclipse.service.jobs
- controls registration of OSGi services. Set to "false" to suppress registration of OSGi services by the
-org.eclipse.core.jobsplug-in- eclipse.service.pref
+- eclipse.service.pref
- Controls registration of OSGi services. Set to "false" to suppress registration of OSGi services by the
-org.eclipse.equinox.preferencesplug-in- eclipse.startTime
+- eclipse.startTime
- This property is set at the time Eclipse is started. The value of this property a string representation of the value returned by System.currentTimeMillis(). This value is not intended to be set by users.
-- eclipse.stateSaveDelayInterval
+- eclipse.stateSaveDelayInterval
- the delay interval (in milliseconds) for persisting state change requests. The default is 30000 ms (30 seconds). State change requests are delayed to prevent massive amounts of disk writes while performing administrative operations (e.g. installing bundles). The delay interval is used to wait for a period of inactivity before persisting the framework state information.
-- eclipse.security
+- eclipse.security
- specifies that a security policy and manager should be configured when the framework is launched. If the launcher is used (org.eclipse.equinox.launcher) and this property is set to any value then the launcher will configure a java.security.Policy that grants all permissions to the launcher and the framework. When the framework is launched it will use this property to determine the security manager to use. If set to osgi then the Equinox security manager is used. This security manager is required to fully support the OSGi Conditional Permission Admin specification. If the property is set to the empty string then java.lang.SecurityManager will be used; otherwise the property specifies a security manager class that should be used as the security manager.
-- eclipse.trace.size.max NEW
+- eclipse.trace.size.max NEW
- the max size in Kb that the trace file is allowed to grow. The trace file is rotated when the file size exceeds the max size. The default value is "1000". A negative value will cause the default value to be used. A zero value indicates no max trace size.
-- eclipse.trace.backup.max NEW
+- eclipse.trace.backup.max NEW
- the max number of backup trace files to allow. The oldest backup trace file will be deleted after the max number of backup trace files is reached as a result of rotating the trace file. The default value is "10". A negative or zero value will cause the default value to be used.
-- eclipse.vm {-vm}
+- eclipse.vm {-vm}
- the path to the Java executable used to run Eclipse. This information is used to construct relaunch command lines.
-- eclipse.vmargs {-vmargs}
+- eclipse.vmargs {-vmargs}
- lists the VM arguments used to run Eclipse. This information is used to construct relaunch command lines.
-- eclipse.orientation {-dir}
+- eclipse.orientation {-dir}
- the workbench orientation which can be ltr (left-to-right) or rtl (right-to-left).
-- equinox.security.vm
+- equinox.security.vm
- If set to "server", security modules will not attempt to substitute VM's JAAS processing.
-- org.eclipse.swt.graphics.Resource.reportNonDisposed
+- org.eclipse.swt.graphics.Resource.reportNonDisposed
- If set to "true", non-disposed SWT Resources will be logged.
-- osgi.adaptor
+- osgi.adaptor
- the class name of the OSGi framework adaptor to use.
-- osgi.arch {-arch}
+- osgi.arch {-arch}
- the processor architecture value. The value should be one of the processor architecture names known to Eclipse (e.g., x86, ppc, sparc, ...). See org.eclipse.osgi.service.environment.Constants for known values.
-- osgi.baseConfiguration.area
+- osgi.baseConfiguration.area
- specifies a base configuration that is used when osgi.configuration.area is not specified.
-- osgi.bundlefile.limit
+- osgi.bundlefile.limit
- specifies a limit on the number of jar files the framework will keep open. The minimum value allowed is 10. Any value less than 10 will disable the bundle file limit, making the the number of jar files the framework keeps open unlimited. By default the value is 100.
-- osgi.bundles
+- osgi.bundles
- The comma-separated list of bundles which are automatically installed and optionally started once the system is up and running. Each entry is of the form:
-
@@ -453,21 +465,21 @@System Properties
If the bundle is a directory bundle then using a file: URL without the use of reference: is not supported (e.g. file:/path/to/myDirectoryBundle_1.0.0/ must use reference:file:/path/to/myDirectoryBundle_1.0.0/)- osgi.bundles.defaultStartLevel
+- osgi.bundles.defaultStartLevel
- this is the startlevel that all bundles will be set to if installed by Eclipse Update. Bundles which are specified on the osgi.bundles list can specify a particular startlevel. If they do not specify a startlevel then they default to the value of osgi.bundles.defaultStartLevel. The default value of osgi.bundles.defaultStartLevel is 4.
-- osgi.compatibility.bootdelegation
+- osgi.compatibility.bootdelegation
- if set to "true" then the parent (boot by default) classloader is delegated to as a last resort if a class or resource cannot be found. The default value is "true".
-- osgi.compatibility.errorOnFailedStart
+- osgi.compatibility.errorOnFailedStart
- A bundle may specify a lazy activation policy using the bundle manifest headers Eclipse-LazyStart or Bundle-ActivationPolicy. According to the OSGi R4.1 specification, if a bundle with a lazy activation policy fails to start then class loads must still succeed. Before the OSGi R4.1 specification Eclipse defined the lazy activation policy such that failed starts would cause class loading errors to be thrown. If osgi.compatibility.errorOnFailedStart is set to "true" then failed starts will result in class loading errors; otherwise the activation error is logged and the classes are allowed to load from bundles which failed to start. The default value is "true".
-- osgi.compatibility.eagerStart.LazyActivation
+- osgi.compatibility.eagerStart.LazyActivation
- The OSGi R4.1 specification mandates that all bundles must be marked for start before they are allowed to activate. This includes bundles which specify a lazy activation policy. A new method Bundle.start(options) has been added to allow lazy activated bundles to be activated according to their lazy activation policy. Before the OSGi R4.1 specification Eclipse defined the lazy activation policy such that @@ -475,19 +487,19 @@
-System Properties
If osgi.compatibility.eagerStart.LazyActivation is set to "true" then bundles with the lazy activation policy will automatically be marked for activation; otherwise bundles with the lazy activation policy must be started with the new Bundle.start(options) method before being allowed to lazy activate. The default value is "true".- osgi.checkConfiguration
+- osgi.checkConfiguration
- if set to "true" then timestamps are check in the configuration cache to ensure that the cache is up to date with respect to the contents of the installed bundles. The default value is "false".
-- osgi.classloader.singleThreadLoads
+- osgi.classloader.singleThreadLoads
- if set to "true" then only one thread is allowed to load a class at a time. The default value is "false". This option can be used to work around certain VM bugs which can cause deadlock. See bug 121737. Note that recent discussions in bug 227587 have shown that this option introduces another kind of deadlock.
-- osgi.classloader.lock
+- osgi.classloader.lock
- the classloader locking strategy to use when defining classes. The valid types are the following: -
-+
@@ -498,39 +510,39 @@
- classname - lock on the classname.
- classloader - lock on the classloader (default value).
System Properties
class loader natively (e.g. the Sun VM). When running on these kinds of VMs deadlock can still occur because of the VM lock.- osgi.classloader.copy.natives NEW
+- osgi.classloader.copy.natives NEW
- If set to "true" then native code which is loaded from a bundle will be copied to a unique location on disk each time a class loader asks to load the library from the bundle. This may be needed in scenarios where the framework is restarted without shutting down the VM. The default value is "false".
-- osgi.classloader.type NEW
+- osgi.classloader.type NEW
- If set to "parallel" then a check is done on JavaSE 7 for the ClassLoader#registerAsParallelCapable method and if found then it is called to allow for parallel class loads. On Java SE 7 this is the preferred way to avoid class loader deadlock because of cyclic class loaders.
-- osgi.clean
+- osgi.clean
- if set to "true", any cached data used by the OSGi framework and eclipse runtime will be wiped clean. This will clean the caches used to store bundle dependency resolution and eclipse extension registry data. Using this option will force eclipse to reinitialize these caches.
-- osgi.configuration.cascaded
+- osgi.configuration.cascaded
- if set to "true", this configuration is cascaded to a parent configuration. The parent configuration is specified by the osgi.sharedConfiguration.area. See the section on locations for more details.
-- osgi.configuration.area {-configuration}
+- osgi.configuration.area {-configuration}
- the configuration location for this run of the platform. The configuration determines what plug-ins will run as well as various other system settings. See the section on locations for more details.
-- osgi.configuration.area.default
+- osgi.configuration.area.default
- the default configuration location for this run of the platform. The configuration determines what plug-ins will run as well as various other system settings. This value (i.e., the default setting) is only used if no value for the osgi.configuration.area is set. See the section on locations for more details.
-- osgi.console {-console [[host:]port]}
+- osgi.console {-console [[host:]port]}
- if set to a non-null value, the OSGi console (if installed) is enabled. This is handy for investigating the state of the system. The value syntax is [[host:]port] where the port and optional host name specify which port @@ -539,10 +551,10 @@
-System Properties
listen to System.in and direct its output to System.out. In order for this option to be supported the Equinox console must be installed. See Console Shell for more information.- osgi.contextClassLoaderParent
+- osgi.contextClassLoaderParent
- the classloader type to use as the parent classloader of the context classloader used by the Framework. The valid types are the following: -
-+
- app - the application classloader.
- boot - the boot classloader.
- ext - the extension classloader.
@@ -551,14 +563,14 @@System Properties
that was set when the framework launched (default value).- osgi.dataAreaRequiresExplicitInit
+- osgi.dataAreaRequiresExplicitInit
- if "true", don't allow clients to initialize instance location if the instance area is not explicitly defined yet. This prevents a plug-in that starts early from accessing the instance area before it has been configured by the osgi.instance.area setting. It is recommended to set osgi.dataAreaRequiresExplicitInit=true. See osgi.instance.area.
-- osgi.debug {-debug}
+- osgi.debug {-debug}
- if set to a non-null value, the platform is put in debug mode. If the value is a string it is interpreted as the location of the .options file. This file indicates what debug @@ -566,7 +578,7 @@
-System Properties
available for a plug-in and whether or not they are enabled. If a location is not specified, the platform searches for the .options file under the install directory.- osgi.dev {-dev}
+- osgi.dev {-dev}
- if set to the empty string, dev mode is simply turned on. This property may also be set to a comma-separated class path entries which are added to @@ -577,7 +589,7 @@
-System Properties
the file will contain an entry of the form
<plug-in id>=<comma separated list of classpath entries to add>where plug-in id "*" matches any plug-in not otherwise mentioned.- osgi.filepermissions.command
+- osgi.filepermissions.command
- specifies an optional OS specific command to set file permissions on extracted native code. On some operating systems it is required that native libraries be set to executable. This optional property allows you to specify the command. @@ -585,14 +597,14 @@
-System Properties
osgi.filepermissions.command="chmod +rx [fullpath]"The [fullpath] is used to substitute the actual file path by the framework.- osgi.framework
+- osgi.framework
- the URL location of the OSGi framework. Useful if the Eclipse install is disjoint. See the section on locations for more details.
-- osgi.frameworkClassPath
+- osgi.frameworkClassPath
- a comma separated list of classpath entries for the OSGi framework implementation. Relative locations are interpreted as relative to the framework location (see osgi.framework)
-- osgi.framework.extensions
+- osgi.framework.extensions
- a comma-separated list of framework extensions. Each entry is of the form:
-
<simple bundle location>Simple bundle locations are searched in the parent directory of the @@ -601,29 +613,29 @@System Properties
system properties. For example, a framework extension that provides a framework adaptor implementation can specify what the adaptor class is by setting the osgi.adaptor property.- osgi.framework.shape
+- osgi.framework.shape
- set to the shape of the Eclipse OSGi Framework implementation. This property is set when the Eclipse platform is started and is not intended by be set by the user. The value "jar" indicates that the Eclipse OSGi Framework is contained in a single jar. The value "folder" indicates that the Eclipse OSGi Framework is contained in a directory.
-- osgi.framework.library.extensions
+- osgi.framework.library.extensions
- a comma separated list of additional library file extensions that must be searched for. If not set then only the library name returned by System.mapLibraryName(String) will be used to search. This is needed for certain operating systems which allow more than one extension for a library. For example AIX allows library extensions of .a and .so, but System.mapLibraryName(String) will only return names with the .a extension.
-- osgi.frameworkParentClassloader
+- osgi.frameworkParentClassloader
- the classloader type to use as the parent classloader for the the Framework. The valid types are the following: -
-+
- app - the application classloader.
- boot - the boot classloader.
- ext - the extension classloader.
- current - the classloader used to load the equinox launcher.
- osgi.framework.activeThreadType
+- osgi.framework.activeThreadType
- if set to normal then an active framework thread is started when the framework is launched that monitors the lifecycle of the framework. This thread is a non-daemon thread and is used to prevent @@ -633,13 +645,13 @@
-System Properties
normal. Setting this option to any other value besides normal will prevent the active framework thread from getting started when the framework is launched.- osgi.framework.useSystemProperties
+- osgi.framework.useSystemProperties
- controls whether the framework properties are backed by the global System properties or held privately for each instance of the framework. By default the framework properties are backed by the System properties (e.g. true). This property is useful when running multiple instances of the OSGi Framework within the same VM and each instance has a separate set of configuration properties (e.g. set in the config.ini).
-- osgi.genericAliases
+- osgi.genericAliases
- a comma separated list of generic aliases that can be used to map existing manifest headers onto Eclipse-GenericCapability and Eclipse-GenericRequire manifest headers. The osgi.genericAliases property uses the following syntax: @@ -651,32 +663,32 @@
-System Properties
the following value:osgi.genericAliases=Export-Service:Import-Service:osgi.service- osgi.hook.configurators
+- osgi.hook.configurators
- a comma separated list of hook configurators. If this property is set then the list of configurators specified will be the only configurators used. Any hook configurators specified in hookconfigurators.properties files will be ignored.
-- osgi.hook.configurators.include
+- osgi.hook.configurators.include
- a comma separated list of additional hook configurators. This is helpful for configuring optional hook configurators. This option is ignored if the osgi.hook.configurators option is used.
-- osgi.hook.configurators.exclude
+- osgi.hook.configurators.exclude
- a comma separated list of hook configurators to exclude. This is helpful for disabling hook configurators that are specified in hook configurator properties files. This option is ignored if the osgi.hook.configurators option is used.
-- osgi.java.profile
+- osgi.java.profile
- a URL to the JRE profile file to use. The specified URL is read as a Java properties file. A JRE profile contains values for the properties org.osgi.framework.system.packages, org.osgi.framework.bootdelegation and org.osgi.framework.executionenvironment. If the osgi.java.profile is not set then a profile is selected based on the java.specification.version value of the running JRE.
-- osgi.java.profile.bootdelegation
+- osgi.java.profile.bootdelegation
- a java profile osgi.java.profile may contain a "org.osgi.framework.bootdelegation" property. This value may be used to set the system property "org.osgi.framework.bootdelegation". The osgi.java.profile.bootdelegation indicates the policy for bootdelegation to be used. The following values are valid (default is ignore): -
-+
- ignore - indicates that the "org.osgi.framework.bootdelegation" value in the java profile should be ignored. The system property "org.osgi.framework.bootdelegation" will be used to @@ -694,17 +706,17 @@
System Properties
- osgi.install.area {-install}
+- osgi.install.area {-install}
- the install location of the platform. This setting indicates the location of the basic Eclipse plug-ins and is useful if the Eclipse install is disjoint. See the section on locations for more details.
-- osgi.instance.area {-data}
+- osgi.instance.area {-data}
- the instance data location for this session. Plug-ins use this location to store their data. For example, the Resources plug-in uses this as the default location for projects (aka the workspace). See the section on locations for more details. Set osgi.dataAreaRequiresExplicitInit to ensure that data area is explicitly initialized before plug-ins can use it.
-- osgi.instance.area.default
+- osgi.instance.area.default
- the default instance data location for this session. Plug-ins use this location to store their data. For example, the Resources plug-in uses this as the @@ -712,68 +724,68 @@
-System Properties
default setting) is only used if no value for the osgi.instance.area is set. See the section on locations for more details.- osgi.locking
+- osgi.locking
- the locking type to use for this run of the platform. The valid locking types are "java.io", "java.nio", and "none". The default value is "java.nio" unless the JRE does not support "java.nio" then "java.io" is the default.
-- osgi.manifest.cache
+- osgi.manifest.cache
- the location where generated manifests are discovered and generated. The default is in the configuration area but the manifest cache can be stored separately.
-- osgi.nl {-nl}
+- osgi.nl {-nl}
- the name of the locale on which Eclipse platform will run. NL values should follow the standard Java locale naming conventions.
-- osgi.nl.extensions {-nlExtensions}
+- osgi.nl.extensions {-nlExtensions}
- the NL extensions, such as collation rules (sorting, searching, grouping), calendar system (locale) and currency format. This is a list of keyword=value pairs. For example:
--nlExtensions "@collation=phonebook;calendar=hebrew;currency=USD"- osgi.nl.user
+- osgi.nl.user
- the name of the locale when the user explicitly adds -nl to the command-line arguments.
-- osgi.noShutdown {-noExit}
+- osgi.noShutdown {-noExit}
- if "true", the OSGi Framework will not be shut down after the Eclipse application has ended. This is useful for examining the OSGi Framework after the Eclipse application has ended. Note that the VM will terminate if no active non-daemon threads exists. See osgi.framework.activeThreadType.
-- osgi.os {-os}
+- osgi.os {-os}
- the operating system value. The value should be one of the operating system names known to Eclipse (e.g., win32, linux, ...). See org.eclipse.osgi.service.environment.Constants for known values.
-- osgi.parentClassloader
+- osgi.parentClassloader
- the classloader type to use as the parent classloader for all bundles installed in the Framework. The valid types are the following: -
-+
- app - the application classloader.
- boot - the boot classloader.
- ext - the extension classloader.
- fwk - the framework classloader.
- osgi.requiredJavaVersion
+- osgi.requiredJavaVersion
- The minimum java version that is required to launch Eclipse. The default value is "1.4.1".
-- osgi.resolverMode
+- osgi.resolverMode
- the mode used to resolve bundles installed in the Framework. The default resolver mode is not strict. The following options are available. -
-+
- strict - the resolver is in strict mode and will enforce access restriction rules when loading classes and resources from exported packages which specify the x-internal or x-friends directives.
- development - used for development time resolution. This mode disables certain resolver rules that are not needed at development time. For example, singleton selection is disabled to allow the development of multiple versions of a singleton bundle
- osgi.resolver.usesMode
+- osgi.resolver.usesMode
- the resolver mode used to resolve uses directives on Export-Package statements. -
-+
- aggressive - aggressively seeks a solution with no class space inconsistencies (default value). This mode may be very expensive depending on the number of bundles and number of duplicate exports in the system.
- tryFirst - only tries the first solution selected by the resolver. This mode is very fast but may result in unresolved bundles because of class space inconsistencies.
- ignore - ignores all uses directives on exports. This mode is very fast by may result in inconsistent class spaces in resolved bundles.
- osgi.sharedConfiguration.area
+- the shared configuration location for this run of the platform. If the osgi.configuration.cascaded property is set to "true" then shared configuration area is used as the parent configuration.
-- osgi.signedcontent.support
+- osgi.signedcontent.support
- A comma separated list of options for signed content support. The valid types are the following: -
-+
- certificate - enables parsing and verification of certificates.
- trust - enables verification of certificate trust. This option implies "certificate".
@@ -783,7 +795,7 @@System Properties
- all - same as "certificate,trust,runtime,authority".
- osgi.signedcontent.trust.engine
+- osgi.signedcontent.trust.engine
- A service property key used to identify an implementation of the org.eclipse.osgi.service.security.TrustEngine service. A TrustEngine service should be registered with a unique value for this property to allow selection of the TrustEngine @@ -791,15 +803,15 @@
-System Properties
property to select particular TrustEngine service implementations at runtime. If this property is not set then all available TrustEngine services are used at runtime.- osgi.splashLocation
+- osgi.splashLocation
- the absolute URL location of the splash screen (.bmp file) to to show while starting Eclipse. This property overrides any value set in osgi.splashPath.
-- osgi.splashPath
+- osgi.splashPath
- a comma separated list of URLs to search for a file called splash.bmp. This property is overriden by any value set in osgi.splashLocation.
-- osgi.startLevel
+- osgi.startLevel
- the start level value the framework will be set to at startup. The default value is 6.
-- osgi.strictBundleEntryPath
+- osgi.strictBundleEntryPath
- On some operating systems Equinox may return a bundle entry that is requested with a path that does not correspond to an actual bundle entry path. For example, on Windows file name comparison operations are @@ -808,53 +820,53 @@
-System Properties
of Equinox. This property is relevant only when the bundle is installed from a folder (not jarred) and is ignored otherwise.- osgi.support.multipleHosts NEW
+- osgi.support.multipleHosts NEW
- if set to true then the framework will attempt to attach a fragment to all available host bundles which satisfy the fragment bundle's Fragment-Host constraint. The default value is false.
-- osgi.support.signature.verify
+- osgi.support.signature.verify
- This option has been deprecated. Use osgi.signedcontent.support instead.
-- osgi.support.class.certificate
+- osgi.support.class.certificate
- if set to true then the certificates available from a signed bundle are used when defining the classes from the signed bundle. The default value is true. This option only takes effect when osgi.signedcontent.support is set to certificate.
-- osgi.syspath
+- osgi.syspath
- set to the path where the eclipse OSGi Framework (org.eclipse.osgi) implementation is located. For example, "<eclipse install path>/eclipse/plugins". This property is set when the Eclipse platform is started and is not intended by be set by the user.
-- osgi.user.area {-user}
+- osgi.user.area {-user}
- the location of the user area. The user area contains data (e.g., preferences) specific to the OS user and independent of any Eclipse install, configuration or instance. See the section on locations for more details.
-- osgi.user.area.default
+- osgi.user.area.default
- the default location of the user area. The user area contains data (e.g., preferences) specific to the OS user and independent of any Eclipse install, configuration or instance. This value (i.e., the default setting) is only used if no value for the osgi.user.area is set. See the section on locations for more details.
-- osgi.ws {-ws}
+- osgi.ws {-ws}
- the window system value. The value should be one of the Eclipse window system names known to Eclipse (e.g., win32, motif, ...).
Environment Variables
+Environment Variables
The following environment variables are used by the Eclipse runtime. They may have command line equivalents (see the command line arguments section). Users are free to use either command line or environment variables to specify a value.
-
-- ECLIPSE_KEYRING
+- ECLIPSE_KEYRING
- Set to override the location of the default secure storage. See the -eclipse.keyring command line option.
Locations +
Locations
The Eclipse runtime defines a number of locations which give plug-in developers context for reading/storing data and Eclipse users a control over @@ -950,92 +962,92 @@
More Details
results in a value of
file:/usr/share/eclipse/myWorkspace