Jump to: navigation, search

Equinox CVS Structure

Revision as of 16:19, 20 February 2008 by Tjwatson.us.ibm.com (Talk | contribs)

Where Should Equinox Components Go?

The CVS components for the eclipse.equinox sub-project use the following folder layout:

 org.eclipse.equinox/<component-name>/bundles/<bundle-project-name>
 org.eclipse.equinox/<component-name>/features/<feature-project-name>

Where component-name is the same name used for the bugzilla component and Unix group. For example, p2, security, framework, bundles etc. and bundle-project-name is the bundle symbolic name for the bundle project and feature-project-name is the symbolic name of the feature. This way each component is grouped under one directory. The bundles directory is intended to separate the actual bundle projects from other content associated with the component. For example, we may want a docs folder to place documents about the component and a features to contain the features associated with a component. So the overall structure looks something like this:

 org.eclipse.equinox/
                    p2/
                       bundles/
                              org.eclipse.equinox.p2.artifact.optimizers
                              org.eclipse.equinox.p2.artifact.processors
                              org.eclipse.equinox.p2.artifact.repository
                              org.eclipse.equinox.p2.console
                             ...
                       features/
                       docs/
                    security/
                       bundles/
                              org.eclipse.equinox.security
                              org.eclipse.equinox.security.tests
                              org.eclipse.equinox.security.ui
                              org.eclipse.equinox.security.win32.x86
                       features/
                       docs/

With the proposal of the new top-level RT project, Equinox will eventually move to a new home in CVS. For newly created components in eclipse.equinox we should attempt to structure CVS the way that we think makes sense when the move is made to the RT top-level project.