blob: 3630558f42a5e808dddbaebe8a509e93e51ca688 [file] [log] [blame]
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Building the OCL Project</title>
<link href="book.css" rel="stylesheet" type="text/css">
<meta content="DocBook XSL Stylesheets V1.75.1" name="generator">
<link rel="home" href="index.html" title="OCL Documentation">
<link rel="up" href="index.html" title="OCL Documentation">
<link rel="prev" href="Extensionpoints.html" title="Extension points">
<link rel="next" href="MavenCentralandrepo.eclipse.org.html" title="Maven Central and repo.eclipse.org">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<h1 xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">Building the OCL Project</h1>
<div class="chapter" title="Building the OCL Project">
<div class="titlepage">
<div>
<div>
<h2 class="title">
<a name="BuildingtheOCLProject"></a>Building the OCL Project</h2>
</div>
</div>
</div>
<div class="toc">
<dl>
<dt>
<span class="section"><a href="BuildingtheOCLProject.html#OOMPH">OOMPH</a></span>
</dt>
<dt>
<span class="section"><a href="MavenCentralandrepo.eclipse.org.html">Maven Central and repo.eclipse.org</a></span>
</dt>
<dt>
<span class="section"><a href="MavenandGradle.html">Maven and Gradle</a></span>
</dt>
<dt>
<span class="section"><a href="GenAnnotations.html">GenModel GenAnnotations</a></span>
</dt>
</dl>
</div>
<p>This section contains some details on the way in which the OCL project is built. This should only be of interest to users creating extension of the project.</p>
<p>The interactive build facilities may be found in the org.eclipse.ocl.examples.build plugin. The &ldquo;Generate OCL All&rdquo; launch invokes all the sub-generators for models and editors.</p>
<p>The documentation build uses the &ldquo;OCL Documentation&rdquo; Ant external launch; see org.eclipse.ocl.doc/libs/Readme.txt for prerequisites. The build populates the help/html/manual folders whose content should be committted to GIT to ensure that the regular build uses the updated documentation. Publishing ocl.pdf is an option that can be selected when performing a final Jenkins reklease build.</p>
<p>The Javadoc build uses the &ldquo;Run OCL Javadoc using Ant directly&rdquo; Ant external launch. The build populates the javadoc folder which should not be committted to GIT. Generating and publishing the javadoc is an option that can be selected when performing a final Jenkins release build.</p>
<p>The distribution build facilities uses the Maven pom.xml in the org.eclipse.ocl.releng.tycho plugin. The &ldquo;Build OCL Distribution - Nightly&rdquo; replicates the Jenkins build locally differing only the absence of the final signing. The build populates the org.eclipse.ocl.releng.build-site plugin</p>
<div class="section" title="OOMPH">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a name="OOMPH"></a>OOMPH</h2>
</div>
</div>
</div>
<p>There is an org.eclipse.ocl.oomph/setups/ocl.setup that users may find helpful to create a development workspace, but the setup is not used by the developers and so may be stale.</p>
</div>
</div>
</body>
</html>