Difference between pages "Theory Plug-in Developer Documentation" and "CamilleX"

From Event-B
(Difference between pages)
Jump to navigationJump to search
(Update path to file used to generate update site)
 
 
Line 1: Line 1:
This page provides some documentation for developers of the Theory plug-in. Documentation for users of the plug-in is available in [[Theory Plug-in|this page]].
+
{{TOCright}}
 +
Return to [[Rodin Plug-ins]]
  
== Eclipse setup ==
+
The CamilleX feature provides text editors for XContexts and and XMachines which then compiled automatically to Event-B contexts and machines.
 +
Extension to Event-B including the ''machine inclusion'' mechanism is also supported.
  
* Clone the [https://sourceforge.net/p/rodin-b-sharp/theory git repository] from Sourceforge
+
<br style="clear: both" />
* Import the subdirectories of the git repository in Eclipse (each subdirectory corresponds to an Eclipse project providing an Eclipse feature or plug-in)
 
* Open <code>org.eventb.theory.feature/org.eventb.theory.feature.target</code> and click on ''Set as Active Target Platform'', at the top right of the window; this assumes that the [https://sourceforge.net/projects/rodin-b-sharp/files/Core_Rodin_Platform/3.5/org.rodinp.dev-3.5.0-9f39f1653.zip/download Rodin target platform] has been downloaded and put in <code>/var/tmp</code>: if this location is not available, or if another version of Rodin is should be targeted, edit the <code>.target</code> file accordingly
 
  
== Release checklist ==
+
Please have a look also at the [[CamilleX User Guide]].
  
To release a new version of the plug-in:
+
=== Current version ===
 +
The CamilleX version 2.1.0 is available as a separate feature from the main Soton Plug-in update site (under the ''CamilleX'' category).  Notice that the Soton plug-in update site is now included in the composite Rodin Update Site.
  
* Tag the last commit with the version number (remember to pass the <code>--tags</code> flag to <code>git push</code> to publish it)
+
=== Principles ===
* On Sourceforge, create a new folder with the version number in the [https://sourceforge.net/projects/rodin-b-sharp/files/Plugin_Theory/ plug-in's directory] and upload the files of the update site there (they are built in <code>org.eventb.theory.repository/target/repository</code>)
+
The CamilleX editors (i.e., XContext and XMachine editors) operate on the separate XContext and XMachine text file and they are compiled to the Rodin files.
* Update the composite Eclipse repository that provides the Rodin plug-ins:
 
** Clone the <code>RodinUpdateSite</code> folder from the [https://sourceforge.net/p/rodin-b-sharp/svn/HEAD/tree/trunk/RodinUpdateSite/ Subversion repository] and import it in Eclipse
 
** Open the <code>composite/compSite.xml</code> file, add a <code>&lt;repository&gt;</code> line for the new version and follow the instructions in the file's comments to build the composite repository
 
** Connect with an SFTP client to <code>web.sourceforge.net</code> (see [https://sourceforge.net/p/forge/documentation/SFTP#for-managing-project-web-space Sourceforge's documentation]) and upload the files built previously (<code>p2.index</code>, <code>compositeArtifacts.jar</code>, <code>compositeContent.jar</code>) in <code>/home/project-web/rodin-b-sharp/htdocs/updates</code>
 
* Publish the release notes in the [[Theory Release History]] page, update the table in the [[Rodin Platform Releases]] page and list the release in [[Template:Dev News]] (it is included in the front page)
 
* Announce the release on the Rodin mailing lists rodin-b-sharp-user@lists.sourceforge.net and rodin-b-sharp-announce@lists.sourceforge.net
 
 
 
[[Category:Developer documentation]]
 
[[Category:Theory Plug-in]]
 

Latest revision as of 13:09, 19 July 2021

Return to Rodin Plug-ins

The CamilleX feature provides text editors for XContexts and and XMachines which then compiled automatically to Event-B contexts and machines. Extension to Event-B including the machine inclusion mechanism is also supported.


Please have a look also at the CamilleX User Guide.

Current version

The CamilleX version 2.1.0 is available as a separate feature from the main Soton Plug-in update site (under the CamilleX category). Notice that the Soton plug-in update site is now included in the composite Rodin Update Site.

Principles

The CamilleX editors (i.e., XContext and XMachine editors) operate on the separate XContext and XMachine text file and they are compiled to the Rodin files.