Jump to: navigation, search

Difference between revisions of "Equinox CVS Structure"

(New page: == 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 compo...)
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Where Should New Equinox Components Go? ==
+
== Where Should 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.
+
The CVS components for the eclipse.equinox sub-project use the following folder layout:
 
+
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
+
  
 
<code>
 
<code>
 
   org.eclipse.equinox/<component-name>/bundles/<bundle-project-name>
 
   org.eclipse.equinox/<component-name>/bundles/<bundle-project-name>
 +
  org.eclipse.equinox/<component-name>/features/<feature-project-name>
 
</code>
 
</code>
  
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:
+
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:
  
 
<code>
 
<code>
Line 19: Line 18:
 
                               org.eclipse.equinox.p2.console
 
                               org.eclipse.equinox.p2.console
 
                               ...
 
                               ...
 +
                        features/
 
                         docs/
 
                         docs/
 
                     security/
 
                     security/
Line 26: Line 26:
 
                               org.eclipse.equinox.security.ui
 
                               org.eclipse.equinox.security.ui
 
                               org.eclipse.equinox.security.win32.x86
 
                               org.eclipse.equinox.security.win32.x86
 +
                        features/
 
                         docs/
 
                         docs/
 
</code>
 
</code>
 +
 +
Since the creation of the top-level RT project, Equinox has lived in the RT repo at /cvsroot/rt/org.eclipse.equinox.  Prior to the creation of RT, Equinox was found in the [[Eclipse Project]] repository at /cvsroot/eclipse/org.eclipse.equinox.
 +
 +
[[Category:Equinox|CVS Structure]]

Latest revision as of 20:36, 30 October 2008

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/

Since the creation of the top-level RT project, Equinox has lived in the RT repo at /cvsroot/rt/org.eclipse.equinox. Prior to the creation of RT, Equinox was found in the Eclipse Project repository at /cvsroot/eclipse/org.eclipse.equinox.