Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAxel Richard2015-05-13 15:59:24 +0000
committerLaurent Goubet2015-05-18 07:08:58 +0000
commit57d813ccb5550ed84ee725ed3291d660b14d23b9 (patch)
treeda7f1912c4c1eae611fa0668d20c6b17b5130384 /plugins
parent54552cfcf2530596a404a2669de1eff25094affd (diff)
downloadorg.eclipse.emf.compare-57d813ccb5550ed84ee725ed3291d660b14d23b9.tar.gz
org.eclipse.emf.compare-57d813ccb5550ed84ee725ed3291d660b14d23b9.tar.xz
org.eclipse.emf.compare-57d813ccb5550ed84ee725ed3291d660b14d23b9.zip
[Doc] Update user guide3.1.0RC1
Change-Id: Ia28b650a9924ed5eadcfbfbe770a23f62e6ae6ea Signed-off-by: Axel Richard <axel.richard@obeo.fr>
Diffstat (limited to 'plugins')
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_Model_Resolver_Preference_Page.pngbin53728 -> 120060 bytes
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_1.pngbin0 -> 164818 bytes
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_2.pngbin0 -> 232191 bytes
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_ResourceNameChange.pngbin0 -> 100346 bytes
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/user/user-guide.mediawiki75
5 files changed, 60 insertions, 15 deletions
diff --git a/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_Model_Resolver_Preference_Page.png b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_Model_Resolver_Preference_Page.png
index 2fcb5c128..c8eac0fbd 100644
--- a/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_Model_Resolver_Preference_Page.png
+++ b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_Model_Resolver_Preference_Page.png
Binary files differ
diff --git a/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_1.png b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_1.png
new file mode 100644
index 000000000..58a2fbe47
--- /dev/null
+++ b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_1.png
Binary files differ
diff --git a/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_2.png b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_2.png
new file mode 100644
index 000000000..a60a9bdb0
--- /dev/null
+++ b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_NotLoadedItems_2.png
Binary files differ
diff --git a/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_ResourceNameChange.png b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_ResourceNameChange.png
new file mode 100644
index 000000000..38083a4a3
--- /dev/null
+++ b/plugins/org.eclipse.emf.compare.doc/src/images/EMF_Compare_ResourceNameChange.png
Binary files differ
diff --git a/plugins/org.eclipse.emf.compare.doc/src/user/user-guide.mediawiki b/plugins/org.eclipse.emf.compare.doc/src/user/user-guide.mediawiki
index c0787ef4a..58e72d55b 100644
--- a/plugins/org.eclipse.emf.compare.doc/src/user/user-guide.mediawiki
+++ b/plugins/org.eclipse.emf.compare.doc/src/user/user-guide.mediawiki
@@ -14,6 +14,7 @@ Using the bundled Eclipse marketplace client you can install EMF Compare in one
EMF has been part of the Eclipse release train since Galileo, you can install it using the following update sites, depending on your platform. '''Note''' that the following are not meant to be visited in your internet browser; they must be pasted in the ''Help > Install New Software'' dialog of your Eclipse, as p2 repositories.
+ http://download.eclipse.org/releases/mars
http://download.eclipse.org/releases/luna
http://download.eclipse.org/releases/kepler
http://download.eclipse.org/releases/juno
@@ -30,8 +31,9 @@ Please note that the EMF Compare development team does its best to maintain down
{| border="1"
|-
! EMF Compare
-! bgcolor="#cccccc" align="center" | Eclipse 4.4 - EMF 2.10
-! Eclipse 4.3 - EMF 2.9
+! bgcolor="#cccccc" align="center" | Eclipse 4.5 - EMF 2.11
+! align="center" | Eclipse 4.4 - EMF 2.10
+! align="center" | Eclipse 4.3 - EMF 2.9
! align="center" | Eclipse 4.2 - EMF 2.8
! align="center" | Eclipse 3.8 - EMF 2.8
! align="center" | Eclipse 3.7 - EMF 2.7
@@ -41,7 +43,21 @@ Please note that the EMF Compare development team does its best to maintain down
! align="center" | Eclipse 3.3 - EMF 2.3
! align="center" | Eclipse 3.2 - EMF 2.2
|-
-| bgcolor="#cccccc" align="center" | 3.0
+| bgcolor="#cccccc" align="center" | 3.1
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#46a546" | &nbsp;
+| bgcolor="#9d261d" | &nbsp;
+| bgcolor="#9d261d" | &nbsp;
+| bgcolor="#9d261d" | &nbsp;
+| bgcolor="#9d261d" | &nbsp;
+|-
+| bgcolor="#ffffff" align="center" | 3.0
+| bgcolor="#ffffff" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -55,6 +71,7 @@ Please note that the EMF Compare development team does its best to maintain down
|-
| align="center" | 2.1
| bgcolor="#ffffff" | &nbsp;
+| bgcolor="#ffffff" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -68,6 +85,7 @@ Please note that the EMF Compare development team does its best to maintain down
| align="center" | 2.0
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
+| bgcolor="#ffffff" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -81,6 +99,7 @@ Please note that the EMF Compare development team does its best to maintain down
| bgcolor="#9d261d" | &nbsp;
| bgcolor="#9d261d" | &nbsp;
| bgcolor="#9d261d" | &nbsp;
+| bgcolor="#9d261d" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -93,6 +112,7 @@ Please note that the EMF Compare development team does its best to maintain down
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
+| bgcolor="#ffffff" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -105,6 +125,7 @@ Please note that the EMF Compare development team does its best to maintain down
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
+| bgcolor="#ffffff" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -119,6 +140,7 @@ Please note that the EMF Compare development team does its best to maintain down
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
| bgcolor="#ffffff" | &nbsp;
+| bgcolor="#ffffff" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
| bgcolor="#46a546" | &nbsp;
@@ -210,6 +232,22 @@ When you compare models with one in a read-only mode, the icons are:
*[[Image:./../images/merged_ov.gif|Accepted change]] represent a change that has been accepted.
*[[Image:./../images/removed_ov.gif|Rejected change]] represent a change that has been rejected.
+==== Items for not loaded fragments ====
+
+When a model is split into fragments, and only some of them have changes, the structure merge viewer (upper part of the comparison editor) and the content merge viewers (lower parts of the comparison editor) display the models involved in the comparison but don’t display the fragments that have no changes.
+
+If a change (x) is detected in a fragment (B), and this fragment is a child of another fragment (A) that has no changes, then (A) won't appear in the structure merge viewer (upper part of the comparison editor) and the content merge viewers (lower parts of the comparison editor). As a result, users will think (B) is the root of the global model.
+
+To avoid this, the idea is to display intermediate node(s) (represented as [ ... ]) in order to show to users that it exists something (fragments, i.e. a parts of models) between/above the changes.
+
+{| border="1" cellpadding="5" cellspacing="0" align="center"
+|-
+! align="center" | Before
+! align="center" | After
+|-
+| [[Image:./../images/EMF_Compare_NotLoadedItems_1.png|650px|center]]
+| [[Image:./../images/EMF_Compare_NotLoadedItems_2.png|650px|center]]
+|}
== Launch Comparison ==
@@ -233,7 +271,7 @@ You can also compare your local model with one of its previous version available
[[Image:./../images/EMFC_Compare_With.png|center]]
-=== Compare with remote models ===
+=== Compare with remote models (EGit) ===
The following displays the important part of a model life cycle with regards to the comparison. The full life cycle can be followed on [[./sample-use-case.html| Sample Use Case]]
@@ -314,6 +352,12 @@ Accept '''all''' differences is not what we seek : we want to keep the changes w
[[Image:./../images/EMF_Compare_Merged.png|center]]
+==== Resource name changes ====
+
+In case of a comparison with remote models, EMF Compare will detect resource name changes. The comparison editor will allows you to accept or reject those changes. Furthermore, in case of a Papyrus diagram & model renaming (renaming all .di, .notation and .uml files), the 3 differences will be accepted or rejected together, in order to maintain the consistency of the models.
+
+[[Image:./../images/EMF_Compare_ResourceNameChange.png|center]]
+
== Customization ==
@@ -395,6 +439,7 @@ On this page you will find all registered post processors. They have been sorted
==== Model Resolvers ====
For each comparison, EMF Compare needs to define which resources are about to be compared. This scope is called the logical model (see [[./../developer/logical-model.html#What_is_a_logical_model_.3F | Logical Model]]). Model resolvers are used to define strategies to build this logical model.
+The model resolvers will try and find cross referenced resources starting from the compared one in order to determine the logical model that needs to be compared along with it. This can be used to widen or reduce the scope in which EMF Compare will seek these linked resources.
To customize the model resolution behavior go to the "Resolution strategy" preference page.
# Open preferences: Window -> Preferences
@@ -402,21 +447,20 @@ To customize the model resolution behavior go to the "Resolution strategy" prefe
[[File:../images/EMF_Compare_Model_Resolver_Preference_Page.png]]
-===== Disable model resolution =====
-
-EMF Compare can prevent building the logical model. In that case, it will only compare the selected resources. To disable model resolution, uncheck the button called "Enable model resolution".
-
===== Choose a strategy =====
-By default, EMF Compare proposes 3 different strategies:
-* Default: This strategy will use the highest ranking model resolver contributed to the platform. With the basic EMF compare installation, this strategy will be "Resolve in project".
-* Resolve in project: This strategy will resolve resources referenced by the current resource and all resources referencing the current resource within its containing project.
-* Resolve descendants: This strategy will resolve all resources referenced by the current resource.
-
-In order to ask EMF Compare to use a specific strategy, first enable the model resolution (if it's not already done) and select it in the combobox.
+EMF Compare proposes different strategies:
+* Workspace: Search for cross-references to (and from) the compared resource within all models from the workspace. '''This strategy is highly recommended in case of a comparison with remote models (EGit).'''
+* Project: Search for cross-references to (and from) the compared resource within all models from its containing project.
+* Container: Search for cross-references to (and from) the compared resource within all models from the same container.
+* Outgoing: Only search for cross-references from the compared resource to its children (and recursively).
Other external strategies might be contributed to EMF Compare. In that case it may happen that the selected strategy can not handle a comparison. If it is so, EMF Compare will use the default strategy.
+===== Disable model resolution =====
+
+EMF Compare can prevent building the logical model. In that case, it will only compare the selected resources. To disable model resolution, check the button called "Disable model resolution".
+
=== User Interface customization ===
==== Colors Customization ====
@@ -517,9 +561,10 @@ This features allows you to filter differences out of the structural view accord
[[Image:./../images/EMF_Compare_Filters_Choice.png]]
+; Empty Resource Mappings : Filter out all resource mappings with no differences from the view. Enabled by default.
+; Feature Map differences : Filters out differences that apply on EFEatureMapEntry type.
; Pseudo conflicts differences : Filter out all pseudo conflicts differences (only in case of a 3-way comparison). Enabled by default.
; Identical elements : Filter out all identical elements (elements with no differences). Enabled by default.
-; Empty Resource Mappings : Filter out all resource mappings with no differences from the view. Enabled by default.
; Cascading differences : Filter out all differences that are contained under differences (except when in conflict). Enabled by default.
PENDING UPDATE, this is a demo displaying EMF Compare 1.3 [http://www.eclipse.org/emf/compare/doc/features/videos/Filters/filters.htm Demo]

Back to the top