collects all associated artifacts for an IU and places them
@@ -84,7 +79,7 @@
Native Touchpoint Actions
"default" action called for IUs with the Native Touchpoint Type as
part of the main Collect and Sizing phases.
-
+
cleanupzip
source, target
@@ -92,7 +87,7 @@
Native Touchpoint Actions
from source into target - i.e. an "undo operation" of an
unzip instruction.
-
+
unzip
source, target
unzips the source into the target directory.
@@ -100,20 +95,20 @@
Native Touchpoint Actions
which denotes the download cache location for the first artifact
key in the installable unit.
-
+
mkdir
path
Creates the directory specified by the parameter path.
-
+
rmdir
path
Removes the directory specified by the parameter path.
Action has no effect if the referenced directory contains files. Use
the remove action for a forced recursive remove.
-
+
ln
targetDir, linkTarget,
linkName, force
@@ -127,7 +122,7 @@
Native Touchpoint Actions
This action is not available on platforms that do not have this command(i.e. Windows)
-
+
chmod
targetDir, targetFile,
permissions, options
@@ -143,7 +138,7 @@
Native Touchpoint Actions
This is not available on platforms that do not have this command (i.e. Windows)
-
+
remove
path
Removes a file, or a directory (and all files under this
@@ -152,7 +147,7 @@
Native Touchpoint Actions
(Since 3.5)
-
+
copy
source, target, overwrite
Copies a file or a directory (and all of its content) denoted
@@ -164,7 +159,7 @@
Native Touchpoint Actions
(Since 3.5)
-
+
cleanupcopy
source, target
@@ -175,28 +170,28 @@
Native Touchpoint Actions
(Since 3.5)
-
+
checkAndPromptNativePackage
distro, package, [comparator, version]
Prompt the user for the package identified if it is not already installed. distro identifies a distribution for which the package is applicable. package is the package identifier as known by the OS. version an optional string capturing the expected version of the package. comparator an optional string from eq, gt, ge, lt, le to express more specific dependencies on the version to install. Know that at this point only Ubuntu is supported, and we welcome support for other OS.
-
Prompt the user for the Windows library identified in the Windows registry if it is not already installed. package is a descriptive library identifier. version an descriptive version string. key is the full registry key. attributeName and attributeValue are an optional name and value of a registry attribute to check. downloadLink is a an optional URL to show in the UI from where the library can be obtained.
-
collects all associated artifacts for an IU and places them
@@ -230,35 +225,35 @@
Eclipse Touchpoint Actions
"default" action called for IUs with the Eclipse Touchpoint Type as
part of the main Collect and Sizing phases.
-
+
installBundle
bundle
Installs a bundle artifact specified by the parameter bundle
-
+
uninstallBundle
bundle
Uninstalls a bundle artifact with a bundle-id specified by
the paramter bundle
-
+
addSourceBundle
bundle
Installs a source bundle artifact with the bundle-id
specified by the parameter bundle
-
+
removeSourceBundle
bundle
Removes/uninstalls the source bundle artifact with the
bundle-id specified by the parameter bundle
-
+
installFeature
feature, featureId, version
@@ -271,21 +266,21 @@
Eclipse Touchpoint Actions
specified in the artifact referenced by the feature parameter
if the version parameter has the value default
-
+
uninstallFeature
feature, featureId, version
Uninstalls a feature. Parameters have the same meaning as for
the command installFeature
-
+
setLauncherName
name
Sets the name of the launcher to name. The
launcher name is used to configure launcher name specific ini files.
-
+
addProgramArg
programArg
@@ -294,7 +289,7 @@
Eclipse Touchpoint Actions
@artifact, the location of the artifact referenced by the
first artifact key in the IU is used as the parameter value.
-
+
removeProgramArg
programArg
@@ -303,14 +298,14 @@
Eclipse Touchpoint Actions
location of the artifact referenced by the first artifact key in the
IU is used as the parameter value.
-
+
setStartLevel
startLevel
Sets the start level to the integer value specified in the
parameter startValue
-
+
markStarted
started
@@ -318,7 +313,7 @@
Eclipse Touchpoint Actions
installable unit as started or not started, as controlled by the boolean parameter started.
A parameter value of "true" will mark the bundle as started and "false" will mark the bundle as not started).
-
+
setFrameworkDependentProperty
propName, propValue
@@ -327,7 +322,7 @@
Eclipse Touchpoint Actions
properties are properties specific to the Equinox implementation of
the OSGi framework.
-
+
setFrameworkIndependentProperty
propName, propValue
@@ -336,7 +331,7 @@
Eclipse Touchpoint Actions
properties do not specifically target Eclipse and are generally
applicable to other OSGi frameworks.
-
+
addProgramProperty
propName, propValue
@@ -346,7 +341,7 @@
Eclipse Touchpoint Actions
properties are used by the executable program to among other things locate
the jars needed to start Eclipse.
-
+
removeProgramProperty
propName, propValue
@@ -357,7 +352,7 @@
Eclipse Touchpoint Actions
properties are used by the executable program to among other things locate
the jars needed to start Eclipse.
-
+
setProgramProperty
propName, propValue
@@ -366,28 +361,28 @@
Eclipse Touchpoint Actions
executable program to among other things locate the jars needed to
start Eclipse.
-
+
addJvmArg
jvmArg
Adds the string specified in the parameter jvmArg to
the arguments passed to the JVM.
-
+
removeJvmArg
jvmArg
Removes the string specified in the parameter jvmArg
from the arguments passed to the JVM.
-
+
setJvm
jvm
Sets the JVM to be the path specified in the parameter jvm.
If a value of null is specified then the current JVM path value
is removed.
-
+
checkTrust
-
@@ -395,7 +390,7 @@
Eclipse Touchpoint Actions
check should be performed. The checkTrust action is not meant to be
user callable and is done as part of the CheckTrust phase.
The p2 UI allows for hierarchical organization of installable units based on the concept of "categories" where the children
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html
index d8f664d0b73..9152bbe72c5 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html
@@ -1,12 +1,12 @@
-
+
The artifact mirroring application supports duplicating a complete artifact repository into a target repository.
-To perform this operation you simply need an eclipse installation that contains the org.eclipse.equinox.p2.artifact.repository bundle.
+To perform this operation you simply need an eclipse installation that contains the org.eclipse.equinox.p2.artifact.repository bundle.
The following command will copy the complete contents of a source repository into the destination repository. If the destination
repository does not already exist, the mirroring application will create a new repository with the same properties as the source.
@@ -54,7 +54,7 @@
Additional Arguments
Mirroring a Metadata Repository
The metadata mirroring application supports copying a complete metadata repository into a target repository.
-To perform this operation you simply need an eclipse installation that contains the org.eclipse.equinox.p2.metadata.repository bundle.
+To perform this operation you simply need an eclipse installation that contains the org.eclipse.equinox.p2.metadata.repository bundle.
The following command will copy the complete source repository into the destination repository. If the destination
repository does not already exist, the mirroring application will create a new repository with the same properties as the source.
p2 ships with four command line publisher applications that plug-in developers can run. The applications are contained
in org.eclipse.equinox.p2.publisher and org.eclipse.equinox.p2.updatesite. These bundles are
@@ -65,7 +63,7 @@
The product publisher application (org.eclipse.equinox.p2.publisher.ProductPublisher) is a command line application
that is capable of generating metadata (p2 repositories) from a .product file. The product publisher does not generate metadata
@@ -196,9 +194,9 @@
flag indicating that repositories will be appended to as opposed to over-written
-configs <spec>
-
a set of environment properties for the os, ws and arch parameters of the system which the product supports and can be provisioned on;
+
a set of environment properties for the os, ws and arch parameters of the system which the product supports and can be provisioned on;
can specify more than one platform in a comma-separated list of such triplets;
- if the product can support any environment, "-configs ANY" or "-configs ANY.ANY.ANY" should be used.
+ if the product can support any environment, "-configs ANY" or "-configs ANY.ANY.ANY" should be used.
Here is an example of how the product publisher can be used to create a p2 repository from a .product file:
The category publisher application (org.eclipse.equinox.p2.publisher.CategoryPublisher) is a command line application that is capable of
categorizing a set of Installable Units in a given repository. The categorization is driven from a category file. The category publisher
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html
index e603c059df2..24ffac360da 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html
@@ -49,36 +49,36 @@
-org.eclipse.foo.* - for example, org.eclipse.swt.widgets,
-org.eclipse.ui,
-or org.eclipse.core.runtime
+org.eclipse.foo.* - for example, org.eclipse.swt.widgets,
+org.eclipse.ui,
+or org.eclipse.core.runtime
-org.eclipse.foo.internal.* - not API; internal implementation
+org.eclipse.foo.internal.* - not API; internal implementation
packages
-org.eclipse.foo.examples.* - not API; these are examples
+org.eclipse.foo.examples.* - not API; these are examples
-org.eclipse.foo.tests.* - not API; these are test suites
+org.eclipse.foo.tests.* - not API; these are test suites
-API class or interface - a public class or interface in
-an API package, or a public or protected class or interface
+API class or interface - a public class or interface in
+an API package, or a public or protected class or interface
member declared in, or inherited by, some other API class or interface.
The names of API classes and interfaces may legitimately appear in client
code.
-API method or constructor - a public or protected
+API method or constructor - a public or protected
method or constructor either declared in, or inherited by, an API class
or interface. The names of API methods may legitimately appear in client
code.
-API field - a public or protected field either
+API field - a public or protected field either
declared in, or inherited by, an API class or interface. The names of API
fields may legitimately appear in client code.
@@ -167,7 +167,7 @@
Debugging methods. Do not call an API method labelled "for debugging
-purposes only". For example, most toString() methods are in this
+purposes only". For example, most toString() methods are in this
category.
@@ -183,7 +183,7 @@
instances may be created. The contract may also cover things like residual
initialization responsibilities (for example, configuring a certain property
before the instance is fully active) and associated lifecycle responsibilities
-(for example, calling dispose() to free up OS resources hung on
+(for example, calling dispose() to free up OS resources hung on
to by the instance). Classes that are designed to be instantiated by clients
are explicitly flagged in the Javadoc class comment (with words like "Clients
may instantiate.").
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html
index eaef9096f07..1c2e3589697 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html
@@ -17,7 +17,7 @@
Enabling Bidirectional Support
-dir command line parameter. If the -dir command line option
is used this will be the default orientation. Valid values are -dir rtl or -dir ltr.
-
system properties. If the system property eclipse.orientation
+
system properties. If the system property eclipse.orientation
is set this will be used. The recognized values of this property are the same as
the -dir command line argument.
Presence of installed NLS packs for Hebrew, Arabic, Farsi or Urdu.
@@ -32,7 +32,7 @@
Enabling Bidirectional Support
applications must set the default orientation by calling
org.eclipse.jface.Window#setDefaultOrientation(), otherwise it
will assume a default value of SWT.NONE. The default orientation is
-set automatically when running the Workbench. All subclasses of org.eclipse.jface.Window
+set automatically when running the Workbench. All subclasses of org.eclipse.jface.Window
inherit this default orientation.
Views and editors inherit the window orientation from their
parent. Dialogs should inherit orientation by using the shell style of their
@@ -172,7 +172,7 @@
Enabling Your Plug-in for Looking up Alternate Icons
- If the icon reference is in your plugin.xml file, make sure you have the $nl$
+ If the icon reference is in your plugin.xml file, make sure you have the $nl$
prefix on your path and the lookup will be handled for you. If you define your
own extension points that involve icons, be sure to load images in the same way.
Clients that do not need to access any particular function, but just need to start the platform, can use
-org.eclipse.equinox.launcher.Main.run() in the bundle org.eclipse.equinox.launcher. However, clients that need to invoke specific functionality should use
+org.eclipse.equinox.launcher.Main.run() in the bundle org.eclipse.equinox.launcher. However, clients that need to invoke specific functionality should use
EclipseStarter. See the javadoc inside this class for details.
The recommended convention for naming the feature archives is
- <id>_<version>.jar
-
Where <id> is the feature identifier and <version>
+ <id>_<version>.jar
+
Where <id> is the feature identifier and <version>
is the full version identifier contained in the respective feature.xml.
Note that this is a recommended convention that minimizes chance of collisions,
but is not required by the Eclipse architecture. For example, the following
are valid feature archive names
Internally, each feature archive is packaged relative to its feature
directory (but not including the directory path element). The archive has
the following structure
-
feature.xml
- feature<_locale>.properties (see "Translated Feature Information")
- other feature files and subdirectories (TBD)
- META-INF/
- Java jar manifest and security files
+
feature.xml
+ feature<_locale>.properties (see "Translated Feature Information")
+ other feature files and subdirectories (TBD)
+ META-INF/
+ Java jar manifest and security files
Note that feature archives do not contain their constituent plug-ins and fragments.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html
index 739e11e4cac..23efaa4efc3 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html
@@ -15,108 +15,108 @@
Version 4.2 - Last revised May, 2012
The feature manifest format is defined by the following dtd:
The element and attribute definitions are as follows:
@@ -128,24 +128,24 @@
provider-name - optional display label identifying the organization providing
this component. Intended to be translated.
os - optional operating system specification. A comma-separated list of
-operating system designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+operating system designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this feature should only be installed on one of the specified
OS systems. If this attribute is not specified, the feature can be installed
on all systems (portable implementation). This information is used as a
hint by the installation and update support (user can force installation
of feature regardless of this setting).
arch - optional machine architecture specification. A comma-separated list
-of architecture designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+of architecture designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this feature should only be installed on one of the specified
systems. If this attribute is not specified, the feature can be installed
on all systems (portable implementation). This information is used as a
hint by the installation and update support (user can force installation
of feature regardless of this setting).
ws - optional windowing system specification. A comma-separated list of
-window system designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+window system designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this feature should only be installed on one of the specified
WS's. If this attribute is not specified, the feature can be installed
on all systems (portable implementation). This information is used as a
@@ -202,8 +202,8 @@
should be separated to allow alternate URLs to be specified for each national
language. Note, that the "content" of this URL is not what is presented
as the click-through license during installation processing. The click-through
-license is the actual value of the <license> element (eg. <license>click
-through text</license>)
+license is the actual value of the <license> element (eg. <license>click
+through text</license>)
@@ -242,24 +242,24 @@
name properly. This attribute can be used as a 'place holder' to allow Eclipse
to render the name of the optional feature when it is not installed.
os - optional operating system specification. A comma-separated list of
-operating system designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+operating system designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this entry should only be installed on one of the specified OS
systems. If this attribute is not specified, the entry can be installed
on all systems (portable implementation). This information is used as a
hint by the installation and update support (user can force installation
of entry regardless of this setting).
arch - optional machine architecture specification. A comma-separated list
-of architecture designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+of architecture designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this feature should only be installed on one of the specified
systems. If this attribute is not specified, the feature can be installed
on all systems (portable implementation). This information is used as a
hint by the installation and update support (user can force installation
of feature regardless of this setting).
ws - optional windowing system specification. A comma-separated list of
-window system designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+window system designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this entry should only be installed on one of the specified WS's.
If this attribute is not specified, the entry can be installed
on all systems (portable implementation). This information is used as a
@@ -329,24 +329,24 @@
version - required plug-in version (from plugin.xml)
fragment - optional specification indicating if this entry is a plug-in fragment. Default is "false"
os - optional operating system specification. A comma-separated list of
-operating system designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+operating system designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this entry should only be installed on one of the specified os
systems. If this attribute is not specified, the entry can be installed
on all systems (portable implementation). This information is used as a
hint by the installation and update support (user can force installation
of entry regardless of this setting).
arch - optional machine architecture specification. A comma-separated list
-of architecture designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+of architecture designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this feature should only be installed on one of the specified
systems. If this attribute is not specified, the feature can be installed
on all systems (portable implementation). This information is used as a
hint by the installation and update support (user can force installation
of feature regardless of this setting).
ws - optional windowing system specification. A comma-separated list of
-window system designators defined by Eclipse (see Javadoc for
-org.eclipse.core.runtime.Platform).
+window system designators defined by Eclipse (see Javadoc for
+org.eclipse.core.runtime.Platform).
Indicates this entry should only be installed on one of the specified WS's.
If this attribute is not specified, the entry can be installed
on all systems (portable implementation). This information is used as a
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html
index 2f0464a45d1..527e433675d 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html
@@ -18,7 +18,7 @@
The Launcher and Its Shared Library
the executable (eclipse.exe), and a shared library (eclipse_1017.dll). The
executable lives in the root of the eclipse install. The shared library
is in a platform specific fragment,
-org.eclipse.equinox.launcher.[config], in the plugins directory.
+org.eclipse.equinox.launcher.[config], in the plugins directory.
Having the majority of the launcher code in a shared library
that lives in a fragment means that that portion of the launch code can
@@ -28,7 +28,7 @@
The Launcher and Its Shared Library
The Launcher Bundle
Previous versions of Eclipse had a startup.jar JAR file in the root
-of the install. In 3.3, this code has been moved to a plug-in org.eclipse.equinox.launcher in
+of the install. In 3.3, this code has been moved to a plug-in org.eclipse.equinox.launcher in
the plugins directory. Eclipse can still be started directly with java
using, for example:
namespace is managed in conformance with Java's
package naming guidelines; subpackages should not be created without
prior approval from the owner of the package sub-tree. The packages for
-the Eclipse platform are all subpackages org.eclipse. The
-first package name component after org.eclipse is called
-the major package name. The following major packages of org.eclipse
+the Eclipse platform are all subpackages org.eclipse. The
+first package name component after org.eclipse is called
+the major package name. The following major packages of org.eclipse
are assigned in the Eclipse 4.3 release:
-
org.eclipse.ant[.*]- Ant support
- org.eclipse.compare[.*] - Compare support
- org.eclipse.core[.*]- Platform core
- org.eclipse.debug[.*]- Debug
- org.eclipse.equinox[.*]- Equinox sub-project
- org.eclipse.help[.*] - Help support
- org.eclipse.jdi[.*]- Eclipse implementation of Java
+
org.eclipse.ant[.*]- Ant support
+ org.eclipse.compare[.*] - Compare support
+ org.eclipse.core[.*]- Platform core
+ org.eclipse.debug[.*]- Debug
+ org.eclipse.equinox[.*]- Equinox sub-project
+ org.eclipse.help[.*] - Help support
+ org.eclipse.jdi[.*]- Eclipse implementation of Java
Debug Interface (JDI)
- org.eclipse.jdt[.*]- Java development tools
- org.eclipse.jface[.*]- JFace
- org.eclipse.jsch[.*]- Jsch SSH library support
- org.eclipse.ltk[.*]- Generic language tool infrastructure
- org.eclipse.osgi[.*]- Eclipse API for interacting with OSGi
- org.eclipse.pde[.*] - Plug-in Development Environment
- org.eclipse.search[.*] - Search support
- org.eclipse.swt[.*]- Standard Widget Toolkit
- org.eclipse.team[.*]- Team support and Version and
+ org.eclipse.jdt[.*]- Java development tools
+ org.eclipse.jface[.*]- JFace
+ org.eclipse.jsch[.*]- Jsch SSH library support
+ org.eclipse.ltk[.*]- Generic language tool infrastructure
+ org.eclipse.osgi[.*]- Eclipse API for interacting with OSGi
+ org.eclipse.pde[.*] - Plug-in Development Environment
+ org.eclipse.search[.*] - Search support
+ org.eclipse.swt[.*]- Standard Widget Toolkit
+ org.eclipse.team[.*]- Team support and Version and
Configuration Management
- org.eclipse.text[.*]- Text editor framework
- org.eclipse.ui[.*] - Workbench
- org.eclipse.update[.*] - Update/install
+ org.eclipse.text[.*]- Text editor framework
+ org.eclipse.ui[.*] - Workbench
+ org.eclipse.update[.*] - Update/install
The following package name segments are reserved:
-
internal - indicates an internal implementation
+
internal - indicates an internal implementation
package that contains no API
- tests - indicates a non-API package that contains only
+ tests - indicates a non-API package that contains only
test suites
- examples - indicates a non-API package that contains
+ examples - indicates a non-API package that contains
only examples
These name are used as qualifiers, and must only appear following the major
package name. For example,
-
org.eclipse.core.internal.resources - Correct
+
org.eclipse.core.internal.resources - Correct
usage
- org.eclipse.internal.core.resources - Incorrect. internal
+ org.eclipse.internal.core.resources - Incorrect. internal
precedes major package name.
- org.eclipse.core.resources.internal - Incorrect. internal
+ org.eclipse.core.resources.internal - Incorrect. internal
does not immediately follow major package name.
Aside on how the Eclipse Platform is structured: The Eclipse Platform is
@@ -97,37 +97,37 @@
Java Packages
ISV needs to remember should be small, since a profusion of API packages
can make it difficult for ISVs to know which packages they need to import.
Within an API package, all public classes and interfaces are considered
-API. The names of API packages should not contain internal,
-tests,
-or examples to avoid confusion with the scheme for naming
+API. The names of API packages should not contain internal,
+tests,
+or examples to avoid confusion with the scheme for naming
non-API packages.
Internal Implementation Packages All packages that are
part of the platform implementation but contain no API that should be exposed
to ISVs are considered internal implementation packages. All implementation
-packages should be flagged as internal, with the tag occurring
+packages should be flagged as internal, with the tag occurring
just after the major package name. ISVs will be told that all packages
-marked internal are out of bounds. (A simple text search
-for ".internal." detects suspicious reference in source files;
-likewise, "/internal/" is suspicious in .class files).
+marked internal are out of bounds. (A simple text search
+for ".internal." detects suspicious reference in source files;
+likewise, "/internal/" is suspicious in .class files).
Test Suite Packages All packages containing test suites
-should be flagged as tests, with the tag occurring just
+should be flagged as tests, with the tag occurring just
after the major package name. Fully automated tests are the norm; so, for
example,
-org.eclipse.core.tests.resources would contain automated
-tests for API in org.eclipse.core.resources. Interactive tests
-(ones requiring a hands-on tester) should be flagged with interactive
-as the last package name segment; so, for example, org.eclipse.core.tests.resources.interactive
+org.eclipse.core.tests.resources would contain automated
+tests for API in org.eclipse.core.resources. Interactive tests
+(ones requiring a hands-on tester) should be flagged with interactive
+as the last package name segment; so, for example, org.eclipse.core.tests.resources.interactive
would contain the corresponding interactive tests.
Examples Packages All packages containing examples that
-ship to ISVs should be flagged as examples, with the tag
+ship to ISVs should be flagged as examples, with the tag
occurring just after the major package name. For example,
-org.eclipse.swt.examples
+org.eclipse.swt.examples
would contain examples for how to use the SWT API.
Additional rules:
Package names should contain only lowercase ASCII alphanumerics, and avoid
-underscore _ or dollar sign $ characters.
+underscore _ or dollar sign $ characters.
Classes and Interfaces
@@ -139,19 +139,19 @@
Classes and Interfaces
the abbreviation is much more widely used than the long form, such as URL
or HTML).
Examples:
- class Raster;
- class ImageSprite;
+ class Raster;
+ class ImageSprite;
Interface names should be capitalized like class names.
For interface names, we follow the "I"-for-interface convention: all interface
-names are prefixed with an "I". For example, "IWorkspace"
-or "IIndex". This convention aids code readability by making interface
+names are prefixed with an "I". For example, "IWorkspace"
+or "IIndex". This convention aids code readability by making interface
names more readily recognizable. (Microsoft COM interfaces subscribe to
this convention).
Additional rules:
-The names of exception classes (subclasses of Exception) should
-follow the common practice of ending in "Exception".
+The names of exception classes (subclasses of Exception) should
+follow the common practice of ending in "Exception".
Methods
@@ -160,15 +160,15 @@
Methods
Methods should be verbs, in mixed case with the first letter
lowercase, with the first letter of each internal word capitalized.
-The named of methods should follow common practice for naming getters (getX()),
-setters (setX()), and predicates (isX(),
-hasX()).
+The named of methods should follow common practice for naming getters (getX()),
+setters (setX()), and predicates (isX(),
+hasX()).
Variables
@@ -176,39 +176,39 @@
Variables
state
Except for variables, all instance, class, and class constants
are in mixed case with a lowercase first letter. Internal words start with
-capital letters. Variable names should not start with underscore _
-or dollar sign $ characters, even though both are allowed.
+capital letters. Variable names should not start with underscore _
+or dollar sign $ characters, even though both are allowed.
Variable names should be short yet meaningful. The choice of a variable
name should be mnemonic - that is, designed to indicate to the casual observer
the intent of its use. One-character variable names should be avoided except
for temporary "throwaway" variables. Common names for temporary variables
-are i, j, k, m, and n for
-integers; c, d, and e for characters.
+are i, j, k, m, and n for
+integers; c, d, and e for characters.
Examples:
- int i;
- char c;
- float myWidth;
+ int i;
+ char c;
+ float myWidth;
(Note: we are no longer following the convention that prefixes non-constant
-field names with "f", such as "fWidget".)
The names of variables declared class constants and of ANSI
constants should be all uppercase with words separated by underscores ("_").
Examples:
- static final int MIN_WIDTH = 4;
- static final int MAX_WIDTH = 999;
- static final int GET_THE_CPU = 1;
+ static final int MIN_WIDTH = 4;
+ static final int MAX_WIDTH = 999;
+ static final int GET_THE_CPU = 1;
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
-plug-ins are named org.eclipse.ui[.*].
+plug-ins are named org.eclipse.ui[.*].
The plug-in namespace is managed hierarchically; do not create plug-in
without prior approval from the owner of the enclosing namespace.
Extension points that expect multiple extensions should have plural
-names. For example, "builders" rather than "builder".
+names. For example, "builders" rather than "builder".
There is no distinction made between a plug-in archive containing a plug-in
and one containing a plug-in fragment.
The recommended convention for naming the plug-in archives is
- <id>_<version>.jar
-
Where <id> is the plug-in or fragment identifier and <version>
+ <id>_<version>.jar
+
Where <id> is the plug-in or fragment identifier and <version>
is the full version identifier contained in the respective plugin.xml or
fragment.xml. Note that this is a recommended convention that minimizes
chance of collisions, but is not required by the Eclipse architecture.
For example, the following are valid plug-in archive names:
Internally, each plug-in archive packages all the relevant plug-in or
fragment files relative to its plug-in or fragment directory (but not including
the directory path element). The archive has the following structure
-
plugin.xml *OR* fragment.xml
- other plug-in or fragment files and subdirectories
- META-INF/
- Java jar manifest and security files
+
plugin.xml *OR* fragment.xml
+ other plug-in or fragment files and subdirectories
+ META-INF/
+ Java jar manifest and security files
plug-in, as well as configuration of functional extensions (configured into
extension points defined by other plug-ins, or introduced by this plug-in).
-
The XML DTD construction rule element* means zero
-or more occurrences of the element; element? means zero or
-one occurrence of the element; and element+ (used below) means one or more
+
The XML DTD construction rule element* means zero
+or more occurrences of the element; element? means zero or
+one occurrence of the element; and element+ (used below) means one or more
occurrences of the element. Based on the <plugin> definition above, this
means, for example, that a plug-in containing no
extension point declarations or extension configurations is valid (for example,
@@ -133,7 +133,7 @@
Eclipse Platform Plug-in Manifest
Important:
-The content of the <extension> element is declared using the ANY rule.
+The content of the <extension> element is declared using the ANY rule.
This means that any well-formed XML can be specified within the extension
configuration section (between <extension> and </extension> tags).
so that a project that is zipped up or released to a server can be correctly
recreated in another workspace. This file is always called ".project",
and is located as a direct member of the project's content area.
-The name of the file is exposed through the static field DESCRIPTION_FILE_NAME
-on org.eclipse.core.resources.IProjectDescription.
+The name of the file is exposed through the static field DESCRIPTION_FILE_NAME
+on org.eclipse.core.resources.IProjectDescription.
The name, location, and content of this file are part of the workspace
API. This means they are guaranteed not to change in a way that would
@@ -37,11 +37,11 @@
has been repaired. The workspace will not generally attempt to automatically
repair a missing or invalid description file. One exception is that
missing project description files will be regenerated during workspace
-save and on calls to IProject.setDescription.
+save and on calls to IProject.setDescription.
Modifications to the project description file have mostly the same effect
-as changing the project description via IProject.setDescription.
+as changing the project description via IProject.setDescription.
One exception is that adding or removing project natures will not trigger
the corresponding nature's configure or deconfigure method. Another
exception is that changes to the project name are ignored.
@@ -57,60 +57,60 @@
name - the name of the project. Ignored if it does match the
-name of the project using this description. Corresponds to IProjectDescription.getName().
+name of the project using this description. Corresponds to IProjectDescription.getName().
-
<!ELEMENT comment EMPTY>
+
<!ELEMENT comment EMPTY>
comment - a comment for the project. The comment can have
arbitrary contents that are not interpreted by the project or workspace.
-Corresponds to IProjectDescription.getComment().
API Information: The contents of the project description
-file map to the org.eclipse.core.resources.IProjectDescription
+file map to the org.eclipse.core.resources.IProjectDescription
interface. The project description file can be overwritten by the method
-IProject.setDescription().
the class name of the OSGi framework adaptor to use.
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.
+ names known to Eclipse (e.g., x86, ppc, sparc, ...). See org.eclipse.osgi.service.environment.Constants for known values.
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.
+ names known to Eclipse (e.g., win32, linux, ...). See org.eclipse.osgi.service.environment.Constants for known values.
osgi.parentClassloader
the classloader type to use as the parent classloader for all bundles installed
in the Framework. The valid types are the following:
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html
index 2217463f829..30474ff3f4e 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html
@@ -1,12 +1,11 @@
-
+
-
-
-
-
+
+
+
Installation of Examples
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html
index 207999f176a..8e2ef60bcfb 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/whatsNew/platform_isv_whatsnew.html
@@ -1,10 +1,9 @@
-
-
+
+
-
-
-
+
+