Jump to: navigation, search

Equinox CVS Structure

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

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Where Should New Equinox Components Go?

This is a proposal for structuring our new cvs components that are being graduated into the eclipse.equinox project. Currently most cvs components in the eclipse.equinox project are contained in the root of dev.eclipse.org:/cvsroot/eclipse along with all the other cvs components that are under the top-level eclipse project. This flat structure is getting pretty big and hard to work with. For newly graduated components we could do something better.

With the proposal of the new top-level Runtimes project, Equinox will eventually move to a new home in CVS. For newly created components we should attempt to structure CVS in a way that we think makes sense when the move is made to the Runtimes Project. Here is the proposal. Each bundle project will be placed in a folder using the following rules

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

Where component-name is the same name used for the bugzilla component and cvs group. For example, p2, security, transforms etc and bundle-project-name is the bundle symbolic name for the bundle project. For example, org.eclipse.equinox.p2.engine. 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. So the overall structure would look 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
                             ...
                       docs/
                    security/
                       bundles/
                              org.eclipse.equinox.security
                              org.eclipse.equinox.security.tests
                              org.eclipse.equinox.security.ui
                              org.eclipse.equinox.security.win32.x86
                       docs/