Skip to main content
Jump to: navigation, search

Difference between revisions of "EMF Facet"

(This add a link to the MoDisco Developer Guide)
(Using Eclipse Release Update Site (Recommended))
 
(181 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
= Overview =
 
= Overview =
  
'''[http://www.eclipse.org/modeling/emft/facet/ EMF Facet Home page]'''
+
Cf. '''[http://www.eclipse.org/modeling/emft/facet/ EMF Facet Home page]'''
  
 
= Install =
 
= Install =
  
''No binaries available yet''
+
== Using Eclipse Release Update Site '''(Recommended)''' ==
 +
 
 +
To install the latest EMF Facet release, just point your [http://help.eclipse.org/indigo/index.jsp?topic=/org.eclipse.platform.doc.user/tasks/tasks-129.htm Install Manager] to the pre-defined Eclipse simultaneous release update site: http://download.eclipse.org/releases/__release_name__. For instance:
 +
* in an Indigo (3.7) installation the update site will be :  http://download.eclipse.org/releases/indigo/
 +
* in an Juno (4.2) installation the update site will be :  http://download.eclipse.org/releases/juno/
 +
* in an Kepler (4.3) installation the update site will be :  http://download.eclipse.org/releases/kepler/
 +
* in an Luna (4.4) installation the update site will be :  http://download.eclipse.org/releases/luna/
 +
* in an Mars (4.5) installation the update site will be :  <span style="font-size:large; padding: 0 5px 0 5px; background-color:#ffbf00; border-color:green">http://download.eclipse.org/releases/mars/</span>
 +
 
 +
Then, you can select the "'''EMF Facet SDK (Incubation)'''" feature under the "'''Modeling'''" category.
 +
 
 +
=== Update site locations ===
 +
 
 +
* Update sites:
 +
** '''releases''' : http://download.eclipse.org/facet/updates/release/
 +
* Alternative update sites:
 +
** '''milestones''' 1.0.x: http://download.eclipse.org/facet/updates/milestones/1.0
 +
* Dependences:
 +
** SWTBot: http://download.eclipse.org/technology/swtbot/helios/dev-build/update-site
 +
 
 +
=== Update site uses ===
 +
 
 +
The '''releases''' update site :
 +
* contains the release (GA) and the service releases (SR1, SR2, etc.)
 +
* should be used by all regular users
 +
 
 +
The '''milestones''' update sites:
 +
* contain the milestones and release candidates: M1, M2, M3, M4, M5, M6, M7, RC1, RC2, RC3, RC4 (=GA), SR1 RC1, SR1 RC2, SR1 RC3, SR1 RC4 (=SR1), SR2 RC1, SR2 RC2, SR2 RC3, SR2 RC4 (=SR2)
 +
 
 +
The '''integration''' update sites:
 +
* contain the integration build
 +
* are referenced by [http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/tree/emft-emffacet.b3aggrcon emft-emffacet.b3aggrcon].
 +
** the version declared in [http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/tree/emft-emffacet.b3aggrcon emft-emffacet.b3aggrcon] must be used by the builds of other Eclipse projects engaged in the release train.
 +
 
 +
== Using an archived update Site '''(Not Recommended)''' ==
 +
 
 +
You can download the archive of the EMF Facet updates sites from the [http://www.eclipse.org/modeling/emft/facet/downloads/ EMF Facet download page] but '''you will have to resolve the dependencies and find the corresponding archived update sites manually'''. The EMF Facet team does not provide the list of the archived update sites needed to satisfy the dependencies, because it is too complicated to maintain. That's why '''this kind of installation is not recommended'''.
  
 
= Documentation =
 
= Documentation =
  
 
== User documentation ==
 
== User documentation ==
 +
* [http://help.eclipse.org/luna/nav/17 0.4.0 documentation]
  
''No documentation available yet''
+
== Screencasts & Slides ==
 +
* [http://www.slideshare.net/GregoireDupe/emf-facet-nantesdemocamp EMF Facet 0.1.0], [[Eclipse_DemoCamps_Indigo_2011/Nantes|Eclipse DemoCamp Indigo in Nantes]], 2011
 +
* (frensh) [http://neptune.irit.fr/images/files/Neptune2011/Transparents/s13_vlorenzo.pdf MDT : Papyrus : état actuel et perspectives]: Les journées NEPTUNE, May 2011.
 +
** A presentation of Papyrus and of the use of the EMF Facet table by Papyrus.
 +
* [http://www.slideshare.net/fmadiot/emf-facet-eclipsecon-2011-audition-6175334 EMF Facet - A Non-Intrusive Tooling to Extend Metamodels], EMF Facet EclipseCon 2011 Audition, December, 2010.
 +
* [http://www.slideshare.net/fmadiot/emf-facet-ese2010 EMF Facet - A Non-Intrusive Tooling to Extend Metamodels]: Eclipse Summit Europe 2010, November, 2010.
 +
 
 +
== Examples ==
 +
 
 +
The EMF Facet SDK contains example plug-ins. To use or inspect this plug-in :
 +
* Open the wizard File > Import
 +
* Select "Plug-ins and Fragement" and press "Next"
 +
* Select :
 +
** "The active target platform"
 +
** "Select from all plug-ins and fragments found at the specified location"
 +
** Project with source folder
 +
* Press "Next"
 +
* Type "emf.facet.*example" in the "Filter Available Plug-ins ans Fragments" fields
 +
* Press "Add All ->"
 +
* Press "Finish"
 +
 
 +
Example plug-in are now available in your workspace.
  
 
== Project documents ==
 
== Project documents ==
 +
 +
* [http://www.eclipse.org/projects/ip_log.php?projectid=modeling.emft.emf-facet IP log]
 +
* [https://projects.eclipse.org/projects/modeling.emft.emf-facet Project plans]
 +
* [http://download.eclipse.org/facet/metrics.html Project metrics]
 +
* [http://git.eclipse.org/c/facet/org.eclipse.emf.facet.main.git/tree/org.eclipse.emf.facet.doc/mediawiki/API_Policy.mediawiki API Policy]
 +
* [[EMFFacet UI issues]]
 +
* [[EMFFacet Accessibility issues]]
 +
 +
=== Release Train Required Documents ===
 +
* [[EMF_Facet/Indigo| Indigo (EMF Facet 0.1)]]
 +
* [[EMF_Facet/Juno| Juno (EMF Facet 0.2)]]
 +
* [[EMF_Facet/Kepler| Kepler (EMF Facet 0.3)]]
 +
* [[EMF_Facet/Luna| Luna (EMF Facet 0.4)]]
 +
* [[EMF_Facet/Mars| Mars (EMF Facet 1.0)]]
 +
 +
=== Project Creation Documents ===
  
 
* [http://www.eclipse.org/proposals/emf-facet/ EMF Facet Project Proposal]
 
* [http://www.eclipse.org/proposals/emf-facet/ EMF Facet Project Proposal]
* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=322170 Project Provisioning]
 
 
* [https://bugs.eclipse.org/bugs/attachment.cgi?id=176904 Creation review docuware]
 
* [https://bugs.eclipse.org/bugs/attachment.cgi?id=176904 Creation review docuware]
 +
* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=322170 Project Provisioning]
  
 
= Support =
 
= Support =
Line 23: Line 97:
 
* [http://www.eclipse.org/forums/index.php?t=thread&frm_id=19&S=afdd0d7947722ed22234f5cbd7a69131 EMFT Forum]
 
* [http://www.eclipse.org/forums/index.php?t=thread&frm_id=19&S=afdd0d7947722ed22234f5cbd7a69131 EMFT Forum]
 
* [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EMFT.facet Report a bug]
 
* [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EMFT.facet Report a bug]
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=VERIFIED;component=Main;component=Web;product=EMFT.facet;classification=Modeling Open bugs]
+
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=VERIFIED;component=Main;component=Web;product=EMFT.facet;classification=Modeling Opened bugs]
  
 
= Getting Involved =  
 
= Getting Involved =  
  
EMF Facet uses the [[MoDisco/DeveloperGuide|MoDisco's Developer Guide]].
+
== Rule and process ==
 +
* EMF Facet uses the [[MoDisco/DeveloperGuide|MoDisco Developer Guide]].
 +
* EMF Facet contributers and commiter must follow the EMF Facet [[EMF_Facet/Bug_Process|Bug process]].
 +
* Developer mailing list : facet-dev@eclipse.org ([https://dev.eclipse.org/mailman/listinfo/facet-dev registration page], [https://dev.eclipse.org/mhonarc/lists/facet-dev/ archives])
 +
== Source repository ==
 +
* Git web browser: http://git.eclipse.org/c/facet/org.eclipse.emf.facet.main.git/
 +
* Gerrit :
 +
** https://git.eclipse.org/r/#/admin/projects/facet/org.eclipse.emf.facet.main
 +
** ssh://committer_id@git.eclipse.org:29418/facet/org.eclipse.emf.facet.main
 +
** cf. [https://bugs.eclipse.org/bugs/show_bug.cgi?id=467506 Bug 467506]
 +
* Git repository: git://git.eclipse.org/gitroot/facet/org.eclipse.emf.facet.main.git
 +
* SVN: http://dev.eclipse.org/svnroot/modeling/org.eclipse.emft.facet (Read only)
 +
== Build ==
 +
* HIPP: https://hudson.eclipse.org/emf-facet/
 +
* Hudson Master Job: https://hudson.eclipse.org/hudson/job/emffacet-nightly/
 +
* Hudson Maintenance Job: https://hudson.eclipse.org/hudson/job/emffacet-nightly-maintenance/
 +
 
 +
== Technical Architecture rules ==
 +
 
 +
=== coding rules ===
 +
 
 +
Please, before to contribute a patch be sure to conforms with:
 +
* the PMD rule set : http://git.eclipse.org/c/facet/org.eclipse.emf.facet.main.git/tree/org.eclipse.emf.facet.archi.tech.rules/pmd/ruleset.xml
 +
* the checkstyle rule set : http://git.eclipse.org/c/facet/org.eclipse.emf.facet.main.git/tree/org.eclipse.emf.facet.archi.tech.rules/checkstyle/EmfFacet.checkstyle
 +
* all the JDT warnings.
 +
 
 +
=== naming rules ===
 +
* *.metamodel contains the EMF implementation.
 +
* *.core contains classes which are not depended to any framework interacting with the GUI.
 +
* *.ui contains classes which are depended to any framework interacting with the GUI.
 +
 
 +
== Bug tracking ==
 +
 
 +
*[https://dev.eclipse.org/recommenders/committers/confess/#/projects/5547ade3e4b02db8ca2ffb48 Error reporting application]
 +
 
 +
=== Bugzilla Queries ===
 +
 
 +
==== Tracking ====
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;order=Importance;bug_severity=blocker;bug_severity=critical;bug_severity=major;bug_severity=normal;bug_severity=minor;bug_severity=trivial;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=VERIFIED;product=EMFT.facet Non enhancement opened bugs sort by importance] (P1=planed for the next milestone, P2=planed for the next release, P3=not planned yet, P4=planed for the next "non service" release, P5=delayed)
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_severity=enhancement;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=VERIFIED;product=EMFT.facet Enhancement opened bugs sort by importance] (P1=planed for the next milestone, P2=planed for the next release, P3=not planned yet, P4=planed for the next "non service" release, P5=delayed).
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;short_desc=%5BUnit%20Test%20Failure%5D;bug_severity=blocker;bug_severity=critical;bug_severity=major;bug_severity=normal;bug_severity=minor;bug_severity=trivial;bug_severity=enhancement;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=RESOLVED;bug_status=VERIFIED;bug_status=CLOSED;short_desc_type=allwordssubstr;product=EMFT.facet Unit Test Failures]
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;short_desc=%5BDeprecated%5D;bug_severity=blocker;bug_severity=critical;bug_severity=major;bug_severity=normal;bug_severity=minor;bug_severity=trivial;bug_severity=enhancement;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=RESOLVED;bug_status=VERIFIED;bug_status=CLOSED;short_desc_type=allwordssubstr;product=EMFT.facet Deprecated]
 +
 
 +
==== Checking ====
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=RESOLVED&bug_status=CLOSED&f0=OP&f1=OP&f10=OP&f11=flagtypes.name&f12=CP&f13=OP&f14=flagtypes.name&f15=CP&f16=CP&f2=flagtypes.name&f3=CP&f4=OP&f5=flagtypes.name&f6=CP&f7=OP&f8=flagtypes.name&f9=CP&j1=OR&j10=OR&j13=OR&j4=OR&j7=OR&o11=notsubstring&o14=notsubstring&o2=notsubstring&o5=notsubstring&o8=notsubstring&product=EMFT.facet&query_format=advanced&resolution=FIXED&v11=luna%2B&v14=mars%2B&v2=indigo%2B&v5=juno%2B&v8=kepler%2B  Bugs not flaged indigo+, juno+ or kepler+] (must be empty)
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?list_id=1692264;resolution=FIXED;emailtype1=substring;emailassigned_to1=1;query_format=advanced;bug_status=RESOLVED;bug_status=CLOSED;email1=emft.facet-inbox%40eclipse.org;product=EMFT.facet Fixed but not assigned bugs] (must be empty)
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;list_id=1707400;bug_status=RESOLVED;product=EMFT.facet Resolved but not closed bugs] (should be empty)
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?o5=regexp&f1=OP&list_id=5601178&f0=OP&classification=Modeling&o2=notsubstring&f4=OP&v5=.%2B&query_format=advanced&j1=OR&f3=CP&f2=flagtypes.name&j4=OR&f5=attachments.description&f6=CP&component=Main&v2=iplog&f7=CP&product=EMFT.facet Attachments not flagged with iplog+ or iplog-]
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?o5=regexp&f1=OP&list_id=5603982&f0=OP&classification=Modeling&o2=substring&f4=OP&v5=.%2B&query_format=advanced&j1=OR&f3=CP&f2=flagtypes.name&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&bug_status=VERIFIED&j4=OR&f5=attachments.description&f6=CP&component=Main&v2=iplog%2B&f7=CP&product=EMFT.facet Not closed bugs having an iplog+]
 +
 
 +
* [http://eclipse.org/projects/tools/ip_contribution_review.php?id=modeling.emft.emf-facet IP Contribution Review]
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?o5=regexp&f1=OP&list_id=5667942&f0=OP&classification=Modeling&o2=notsubstring&f4=OP&v5=.%2B&query_format=advanced&j1=OR&f3=CP&f2=flagtypes.name&bug_status=RESOLVED&bug_status=CLOSED&j4=OR&f5=attachments.description&f6=CP&component=Main&v2=iplog&f7=CP&product=EMFT.facet Attachments not flagged with iplog+ or iplog- in resoled or closed bugs] (should be empty)
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?list_id=11524146&order=Importance&product=EMFT.facet&query_format=advanced&resolution=FIXED&target_milestone=--- Fixed without target milestone]  (should be empty)
 +
 
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=RESOLVED&product=EMFT.facet&query_format=advanced&resolution=FIXED RESOLVED FIXED] (Should be empty after each release)
 +
 
 +
==== Reports ====
 +
* [https://bugs.eclipse.org/bugs/report.cgi?x_axis_field=version&y_axis_field=bug_severity&z_axis_field=&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&product=EMFT.facet&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&field0-0-0=noop&type0-0-0=noop&value0-0-0=&format=table&action=wrap Opened bugs by severity]
 +
* [https://bugs.eclipse.org/bugs/report.cgi?x_axis_field=target_milestone&y_axis_field=version&z_axis_field=&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&product=EMFT.facet&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&emailtype1=substring&email1=&emailtype2=substring&email2=&bug_id_type=anyexact&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&format=table&action=wrap&field0-0-0=noop&type0-0-0=noop&value0-0-0= Bug resolution by milestones]
 +
* [https://bugs.eclipse.org/bugs/report.cgi?x_axis_field=target_milestone&y_axis_field=version&z_axis_field=&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&product=EMFT.facet&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_severity=enhancement&emailtype1=substring&email1=&emailtype2=substring&email2=&bug_id_type=anyexact&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&format=table&action=wrap&field0-0-0=noop&type0-0-0=noop&value0-0-0= Enhancements by milestones]
 +
 
 +
==== Others ====
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=RESOLVED;bug_status=VERIFIED;bug_status=CLOSED;product=EMFT.facet;classification=Modeling Closed bugs]
 +
* [https://bugs.eclipse.org/bugs/buglist.cgi?classification=Modeling&field0-0-0=attachments.submitter&list_id=1712821&product=EMFT.facet&query_format=advanced&type0-0-0=nowordssubstr&value0-0-0=nbros%20fgiquel%20gdupe%20gbarbier%20fmadiot&order=bug_status%2Cpriority%2Cbug_severity&query_based_on= Non-committer attachments]
  
SVN: http://dev.eclipse.org/svnroot/modeling/org.eclipse.emft.facet
+
== Useful links ==
 +
* [http://eclipse.org/indigo/planning/EclipseSimultaneousRelease.php The Eclipse Simultaneous Release]
  
Developers mailing list: https://dev.eclipse.org/mailman/listinfo/emft-dev
+
== Miscellaneous ==
 +
* [[EMF_Facet/Web_Documentation| Web documentation update]]
 +
* Test scenarios
 +
** [[EMF_Facet/Table/UI_Test|Table UI Test]]
 +
* [[EMF_Facet/Releng/How_to_Use|Releng : How to Use]]
 +
** [http://dev.eclipse.org/viewcvs/viewvc.cgi/org.eclipse.indigo.build/emft-emffacet.b3aggrcon?view=markup&root=Callisto Release train aggregation file]

Latest revision as of 08:57, 28 October 2015

Overview

Cf. EMF Facet Home page

Install

Using Eclipse Release Update Site (Recommended)

To install the latest EMF Facet release, just point your Install Manager to the pre-defined Eclipse simultaneous release update site: http://download.eclipse.org/releases/__release_name__. For instance:

Then, you can select the "EMF Facet SDK (Incubation)" feature under the "Modeling" category.

Update site locations

Update site uses

The releases update site :

  • contains the release (GA) and the service releases (SR1, SR2, etc.)
  • should be used by all regular users

The milestones update sites:

  • contain the milestones and release candidates: M1, M2, M3, M4, M5, M6, M7, RC1, RC2, RC3, RC4 (=GA), SR1 RC1, SR1 RC2, SR1 RC3, SR1 RC4 (=SR1), SR2 RC1, SR2 RC2, SR2 RC3, SR2 RC4 (=SR2)

The integration update sites:

Using an archived update Site (Not Recommended)

You can download the archive of the EMF Facet updates sites from the EMF Facet download page but you will have to resolve the dependencies and find the corresponding archived update sites manually. The EMF Facet team does not provide the list of the archived update sites needed to satisfy the dependencies, because it is too complicated to maintain. That's why this kind of installation is not recommended.

Documentation

User documentation

Screencasts & Slides

Examples

The EMF Facet SDK contains example plug-ins. To use or inspect this plug-in :

  • Open the wizard File > Import
  • Select "Plug-ins and Fragement" and press "Next"
  • Select :
    • "The active target platform"
    • "Select from all plug-ins and fragments found at the specified location"
    • Project with source folder
  • Press "Next"
  • Type "emf.facet.*example" in the "Filter Available Plug-ins ans Fragments" fields
  • Press "Add All ->"
  • Press "Finish"

Example plug-in are now available in your workspace.

Project documents

Release Train Required Documents

Project Creation Documents

Support

Getting Involved

Rule and process

Source repository

Build

Technical Architecture rules

coding rules

Please, before to contribute a patch be sure to conforms with:

naming rules

  • *.metamodel contains the EMF implementation.
  • *.core contains classes which are not depended to any framework interacting with the GUI.
  • *.ui contains classes which are depended to any framework interacting with the GUI.

Bug tracking

Bugzilla Queries

Tracking

Checking

Reports

Others

Useful links

Miscellaneous

Back to the top