Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EMF Compare/Specifications/EnhanceReadabilityOfTheStructuralDifferences"
| Line 22: | Line 22: | ||
== Detailed Specification == | == Detailed Specification == | ||
| − | + | Here is the new version of the labels: | |
| − | + | [[Image:EMFCompare2-StyledLabels_v3.png|alt Styled Labels]] | |
| − | + | On each node, the data displayed are: ''object_name [property_affected type_of_difference]'' | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | [ | + | |
| + | * The object name: the object concerned by the difference (e.g. class, attribute, reference...) | ||
| + | * The property affected: the property of the object concerned by the difference. | ||
| + | * The type of difference: the type of difference found on the property affected (e.g. add, remove, delete, set, unset, move or change) | ||
== Backward Compatibility and Migration Paths == | == Backward Compatibility and Migration Paths == | ||
Revision as of 11:19, 21 January 2013
Evolution Specification: Enhance readability of the structural differences
Current status is DRAFT
Preamble
The difference labels displayed in the structure merge viewer can be quite difficult to read and understand.
_Relevant tickets_ (links to the Bugzilla tickets which are related to the change):
- Bug 398099 - Enhance readability of the structural differences
Introduction
Add some styling to these label to more easily identify:
- if the difference is local or remote,
- the difference kind (addition, change, deletion, move),
- the structural feature affected by the change,
- the label of the element that has changed.
For this purpose, styled texts will be used in the label provider.
Detailed Specification
Here is the new version of the labels:
On each node, the data displayed are: object_name [property_affected type_of_difference]
- The object name: the object concerned by the difference (e.g. class, attribute, reference...)
- The property affected: the property of the object concerned by the difference.
- The type of difference: the type of difference found on the property affected (e.g. add, remove, delete, set, unset, move or change)
Backward Compatibility and Migration Paths
Metamodel Changes
This evolution does not change the metamodel.
API Changes
TODO. (List every API addition, removal and deprecation. For each removal and deprecation, indicate the migration path for existing code.)
User Interface Changes
TODO. (List every user-visible change in the interface. Here "user" includes not only end-users but also developpers.)
Documentation Changes
TODO. (List every documentation needing an update here, starting by the New and Noteworthy documentation.)
Tests and Non-regression strategy
TODO. (This part of the document should describe the strategy to use to correctly test the evolution and guarantee the non-regression.)
Implementation choices and tradeoffs
TODO. (Any important tradeoff or choice made during the implementation should be referenced here with pros/cons leading to the final decision.)