Bugzilla – Full Text Bug Listing
| Summary: | Ensure GEF4 bundle and package names are compliant to Eclipse naming conventions. | ||
|---|---|---|---|
| Product: | [Tools] GEF | Reporter: | Alexander Nyßen <nyssen> |
| Component: | Misc | Assignee: | Alexander Nyßen <nyssen> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | unspecified | ||
| Target Milestone: | 4.0.0 / 3.11.0 (Neon) M3 | ||
| Hardware: | PC | ||
| OS: | Mac OS X | ||
| Whiteboard: | |||
|
Description
Alexander Nyßen
This not only relates to test bundles, thus I generalized the title to indicate that we need to achieve overall consistency in naming our bundles and packages. The eclipse naming conventions prescribe the following for internal, tests, and examples: org.eclipse.<subproject>.internal.<component>[.*] - internal package org.eclipse.<subproject>.tests.<component>[.*] - tests org.eclipse.<subproject>.examples.<component>[.*] - examples Within the GEF4 bundles, we have three different conventions for internal, tests, and examples, namely: 1) internal is used with "gef4" as the subproject, i.e. we have org.eclipse.gef4.internal.geometry and org.eclipse.gef4.internal.dot.parser. 2) examples is used with a respective GEF4 component as the subproject, i.e. we have org.eclipse.gef4.zest.examples.graph or org.eclipse.gef4.mvc.examples.logo. This seems to violate above conventions. 3) tests are used with a respective GEF4 component module as the subproject, i.e. we have org.eclipse.gef4.geometry.convert.fx.tests. This seems to violate above conventions. W.r.t. the above definition it could make sense to map GEF4 components to subprojects and to map the GEF4 component modules to components, or to have GEF4 itself as the subproject and to map GEF4 components to components. In either case, we should make this consistent. Mapping GEF4 modules to components and GEF4 components as subproject (as done for our examples) seems to be the most consistent usage, even while this is not literally in line with the eclipse conventions. BTW, the internal packages within Cloudio are already named org.eclipse.gef4.cloudio.internal.*, while within DOT we have org.eclipse.gef4.internal.dot.*. We should adjust DOT to make this consistent. (In reply to Alexander Nyßen from comment #3) > BTW, the internal packages within Cloudio are already named > org.eclipse.gef4.cloudio.internal.*, while within DOT we have > org.eclipse.gef4.internal.dot.*. We should adjust DOT to make this > consistent. The same holds for Geometry, which should use org.eclipse.gef4.geometry.internal rather than org.eclipse.gef4.internal.geometry. I renamed the o.e.g4.internal.dot.* packages to o.e.g4.dot.internal.*, so GEF4 DOT should now be concise w.r.t. naming of internal packages. Renamed o.e.g4.internal.geometry.* to o.e.g4.geometry.internal.*. Increased version of Geometry component to 0.3.0 as well. Pushed the following (remaining) changes to origin/master: - Renamed o.e.g4.cloudio.tests to o.e.g4.cloudio.tests.ui - Renamed o.e.g4.geometry.convert.swt.tests to o.e.g4.geometry.tests.convert.swt - Renamed o.e.g4.geometry.convert.fx.tests to o.e.g4.geometry.tests.convert.fx - Renamed o.e.g4.mvc.fx.tests to o.e.g4.mvc.tests.fx - Renamed o.e.g4.zest.fx.tests to o.e.g4.zest.tests.fx - Renamed o.e.g4.zest.fx.jface.tests to o.e.g4.zest.tests.fx.jface Thereby, the test bundles are now named appropriately as well. Resolving as fixed in 3.11.0 M3. |