Skip to content

Working With Examples

Luis Diogo Couto edited this page Oct 2, 2015 · 6 revisions

This pages briefly explains how the Overture examples are used as part of Overture builds.

The Overture examples and the VDM libs are hosted and maintained at in the documentation repository. However, they are used for a couple of things in normal Overture builds:

  • the libs are used as resources when building the ide/ui plug-in. They are needed for the Add VDM library.
  • the libs and the examples are used as resources when building the ide/help plug-in. They are need for the Import Examples feature.
  • the libs and the examples are used as resources for testing various core modules through the testing framework.

Because it's stupid to keep two copies of the examples under source control, we've used various solutions for keeping the examples in the documentation repo and making the main repo "depend on them". Up until recently, we used a download plug-in to grab a zip of the entire documentation repository. This worked reasonably well since it was invisible to most developers. But that solution doesn't work anymore*.

*This is because we now need different version of the main repo to depend on different versions of the examples. The symphony and crescendo branches can't depend on the main examples anymore since they won't support pure operations.

In order to depend on different versions

Clone this wiki locally