Commit e1fed83c authored by Dennis Hendriks's avatar Dennis Hendriks
Browse files

Merge branch 'develop' into 'master'

#168 develop to master for v0.3-RC1

See merge request !152
parents a09494e4 60d78ab1
Pipeline #884 failed with stage
in 0 seconds
......@@ -15,8 +15,10 @@ visualization, formal verification, real-time testing, and code generation.
For more information, see:
* Project home: https://projects.eclipse.org/projects/technology.escet
* Website: https://eclipse.org/escet
* GitLab: https://gitlab.eclipse.org/eclipse/escet/escet
* Jenkins: https://ci.eclipse.org/escet/
* Project home: https://projects.eclipse.org/projects/technology.escet
## Developer resources
......@@ -25,7 +27,7 @@ For more information regarding source code management, builds, setting up a
developer environment, coding standards, how to contribute, and more, see
the Eclipse ESCET development documentation at:
* https://eclipse.org/escet/escet/#developer-chapter-index
* https://eclipse.org/escet/escet/developer
The project maintains the following source code repositories:
......@@ -43,9 +45,16 @@ This project uses GitLab to track ongoing development and issues:
Be sure to search for existing issues before you create another one. Remember
that contributions are always welcome!
To contribute source code (e.g. patches), please use GitLab:
To contribute source code (e.g. patches) via GitLab, see:
* https://eclipse.org/escet/escet/developer/contributing.html
To create issues, reply to issues, contribute patches and merge requests, etc,
you need an Eclipse Foundation account. It can easily be created at
https://accounts.eclipse.org/user/register.
* https://gitlab.eclipse.org/eclipse/escet/escet/-/merge_requests
Please start each commit message with the issue number, e.g.
`#NNN Commit summary.` for issue `NNN`.
## Eclipse Contributor Agreement
......
......@@ -6,6 +6,7 @@ maven/mavencentral/org.codehaus.groovy/groovy-ant/3.0.8, Apache-2.0, approved, c
maven/mavencentral/org.codehaus.groovy/groovy-groovydoc/3.0.8, Apache-2.0, approved, #819
maven/mavencentral/org.codehaus.groovy/groovy-json/3.0.8, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.codehaus.groovy/groovy/3.0.8, Apache-2.0, approved, #818
p2/orbit/p2.eclipse-plugin/com.google.guava/30.1.0.v20210127-2300, Apache-2.0 AND LicenseRef-Public-Domain, approved, CQ23002
p2/orbit/p2.eclipse-plugin/com.ibm.icu/67.1.0.v20200706-1749, ICU AND Unicode-TOU AND BSD-3-Clause AND BSD-2-Clause AND LicenseRef-ipadic-license AND LicenseRef-Public-Domain, approved, CQ22320
p2/orbit/p2.eclipse-plugin/com.sun.jna.platform/5.8.0.v20210406-1004, Apache-2.0 OR LGPL-2.1-or-later, approved, CQ23218
p2/orbit/p2.eclipse-plugin/com.sun.jna/5.8.0.v20210503-0343, Apache-2.0 OR LGPL-2.1-or-later, approved, CQ23217
......@@ -150,6 +151,7 @@ p2/orbit/p2.eclipse-plugin/org.eclipse.ui.workbench/3.122.200.v20210506-1640, EP
p2/orbit/p2.eclipse-plugin/org.eclipse.ui/3.119.0.v20210111-1350, EPL-2.0, approved, eclipse.platform
p2/orbit/p2.eclipse-plugin/org.eclipse.urischeme/1.1.400.v20210407-1558, EPL-2.0, approved, eclipse.platform
p2/orbit/p2.eclipse-plugin/org.hamcrest.core/1.3.0.v20180420-1519, BSD-2-Clause, approved, CQ7063
p2/orbit/p2.eclipse-plugin/org.jsoup/1.8.3.v20181012-1713, MIT, approved, CQ12749
p2/orbit/p2.eclipse-plugin/org.junit/4.13.0.v20200204-1500, EPL-1.0, approved, CQ21439
p2/orbit/p2.eclipse-plugin/org.knowm.xchart/3.6.5.v20201023-2252, Apache-2.0, approved, CQ22695
p2/orbit/p2.eclipse-plugin/org.sat4j.core/2.3.5.v201308161310, , approved, CQ7311
......
......@@ -15,7 +15,7 @@ pipeline {
agent {
// The 'centos-7' pod template allows UI tests.
kubernetes {
label 'centos-7'
inheritFrom 'centos-7'
}
}
......
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<launchConfiguration type="org.eclipse.m2e.Maven2LaunchConfigurationType">
<booleanAttribute key="M2_DEBUG_OUTPUT" value="false"/>
<stringAttribute key="M2_GOALS" value="clean package --projects releng/org.eclipse.escet.target,chi/org.eclipse.escet.chi.documentation,cif/org.eclipse.escet.cif.documentation,products/org.eclipse.escet.documentation,setext/org.eclipse.escet.setext.documentation,tooldef/org.eclipse.escet.tooldef.documentation --also-make-dependents"/>
<stringAttribute key="M2_GOALS" value="clean package --projects releng/org.eclipse.escet.target,chi/org.eclipse.escet.chi.documentation,cif/org.eclipse.escet.cif.documentation,products/org.eclipse.escet.documentation,setext/org.eclipse.escet.setext.documentation,tooldef/org.eclipse.escet.tooldef.documentation --also-make"/>
<booleanAttribute key="M2_NON_RECURSIVE" value="false"/>
<booleanAttribute key="M2_OFFLINE" value="false"/>
<stringAttribute key="M2_PROFILES" value=""/>
......
......@@ -321,7 +321,7 @@ public class TypeIDCreation {
/**
* Make a type ID for a set type.
*
* @param st set type.
* @param st Set type.
* @param ctxt Code generator context.
* @return Constructed type ID.
*/
......
......@@ -4,4 +4,5 @@ Bundle-Name: ESCET Chi Documentation (Incubation)
Bundle-SymbolicName: org.eclipse.escet.chi.documentation;singleton:=true
Bundle-Version: 0.3.0.qualifier
Bundle-Vendor: Eclipse ESCET
Require-Bundle: org.eclipse.help
Require-Bundle: org.eclipse.help,
org.eclipse.escet.common.asciidoc;bundle-version="0.3.0"
......@@ -37,4 +37,8 @@
#footer-text, #footer-text a {
color: rgba(255,255,255,.8)
}
.toc-cur-page {
font-weight: bold;
}
</style>
......@@ -111,7 +111,7 @@ include::tutorial/experiments.asciidoc[]
// Tutorial - Visualization
include::tutorial/svg-vis.asciidoc[]
include::tutorial/svg-visualization.asciidoc[]
include::tutorial/svg-example.asciidoc[]
......@@ -123,7 +123,7 @@ include::reference-manual/index.asciidoc[]
:leveloffset: +1
include::reference-manual/global.asciidoc[]
include::reference-manual/globals.asciidoc[]
include::reference-manual/statements.asciidoc[]
......@@ -139,7 +139,7 @@ include::reference-manual/lexicals.asciidoc[]
include::reference-manual/migration.asciidoc[]
include::reference-manual/svg-ref.asciidoc[]
include::reference-manual/svg-visualization.asciidoc[]
:leveloffset: -1
......@@ -151,7 +151,7 @@ include::tool-manual/index.asciidoc[]
include::tool-manual/operation.asciidoc[]
include::tool-manual/commandline.asciidoc[]
include::tool-manual/command-line.asciidoc[]
:leveloffset: -1
......
......@@ -17,16 +17,20 @@ indexterm:[release, notes]
[[release-notes-chapter-index]]
== Chi release notes
The release notes for the releases of Chi and the associated tools, as part of the Eclipse ESCET project, are listed below in reverse chronological order.
The release notes for the versions of Chi and the associated tools, as part of the Eclipse ESCET project, are listed below in reverse chronological order.
The release notes may refer to issues, the details for which can be found at the Eclipse ESCET link:https://gitlab.eclipse.org/eclipse/escet/escet/-/issues[GitLab issues page].
See also the Eclipse ESCET link:https://www.eclipse.org/escet/escet/#release-notes-chapter-index[toolkit release notes] covering those aspects that are common to the various Eclipse ESCET tools.
See also the Eclipse ESCET link:https://eclipse.org/escet/escet/release-notes.html[toolkit release notes] covering those aspects that are common to the various Eclipse ESCET tools.
=== Version 0.3
TBD
Improvements and fixes:
- The website and Eclipse help now use multi-page HTML rather than a single HTML file, although the website still contains a link to the single-page HTML that allows easily searching the full documentation (issue #36).
- Enabled section anchors for documentation on the website, and disabled section anchors for Eclipse help (issue #36).
- Several small documentation fixes and improvements (issues #36 and #166).
=== Version 0.2
......
......@@ -68,7 +68,7 @@ indexterm:[time,in a function]
indexterm:[function,use of time]
A function is a mathematical function: the result of a function is the same for the same values of input parameters.
A function has no _side-effect_, and it cannot access variables outside the body.
For example, it cannot access `time` (explained in <<tut-servers-with-time,Servers with time>>) directly, it has to be passed in through the parameter list.
For example, it cannot access `time` (explained in <<tut-chapter-servers-with-time>>) directly, it has to be passed in through the parameter list.
A function that calculates the sign of a real number, is:
......
......@@ -95,8 +95,8 @@ All processes finished at time 2.25
The three actions are done in 2.25 time units (2.25 minutes).
[[tut-servers-with-time]]
=== Servers with time
[[tut-servers-adding-time]]
=== Adding time
Adding time to the model allows answering questions about time, often performance questions ('how many products can I make in this situation?').
Two things are needed:
......@@ -541,7 +541,7 @@ Two or three components are 'glued' together in one assemble process, followed i
.. Change the model to using time units of one second (that is, one time unit means one second of simulated time).
.. Predict the resulting throughput and flow time for a deterministic case like in <<tut-servers-with-time>>, with `ta = 4` and `ts = 5`.
.. Predict the resulting throughput and flow time for a deterministic case like in <<tut-servers-adding-time>>, with `ta = 4` and `ts = 5`.
Verify the prediction with an experiment, and explain the result.
. Extend the model <<tut-figure-controlled-factory,A controlled factory>> in <<tut-buffer-exercises,Buffer exercises>> with a single deterministic server taking `4.0` time units to model the production capacity of the factory.
......
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<launchConfiguration type="org.eclipse.m2e.Maven2LaunchConfigurationType">
<booleanAttribute key="M2_DEBUG_OUTPUT" value="false"/>
<stringAttribute key="M2_GOALS" value="clean package --projects releng/org.eclipse.escet.target,chi/org.eclipse.escet.chi.documentation --also-make-dependents"/>
<stringAttribute key="M2_GOALS" value="clean package --projects releng/org.eclipse.escet.target,chi/org.eclipse.escet.chi.documentation --also-make"/>
<booleanAttribute key="M2_NON_RECURSIVE" value="false"/>
<booleanAttribute key="M2_OFFLINE" value="false"/>
<stringAttribute key="M2_PROFILES" value=""/>
......
......@@ -15,7 +15,7 @@
<extension
point="org.eclipse.help.toc">
<toc
file="target/eclipse-help/toc.xml"
file="toc.xml"
primary="true">
</toc>
</extension>
......
......@@ -23,9 +23,9 @@
<artifactId>org.eclipse.escet.chi.documentation</artifactId>
<packaging>eclipse-plugin</packaging>
<!-- See https://github.com/asciidoctor/asciidoctor-maven-examples for ASCIIDOC Maven configuration examples -->
<build>
<plugins>
<!-- Generate documentation from AsciiDoc sources. -->
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
......@@ -44,7 +44,7 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>${project.build.directory}/eclipse-help/index.html</outputFile>
<outputFile>${project.build.directory}/eclipse-help-intermediate/index.html</outputFile>
<backend>html5</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<logHandler>
......@@ -55,15 +55,14 @@
<attributes>
<attribute-missing>warn</attribute-missing>
<linkcss>true</linkcss>
<imgsdir>../../images</imgsdir>
<imgsdir>images</imgsdir>
<icons>font</icons>
<sectanchors>true</sectanchors>
<sectanchors>false</sectanchors>
<html-output>true</html-output>
<eclipse-help-output>true</eclipse-help-output>
</attributes>
</configuration>
</execution>
<execution>
<id>generate-pdf</id>
<phase>generate-resources</phase>
......@@ -72,7 +71,7 @@
</goals>
<configuration>
<outputFile>
${project.build.directory}/website/eclipse-escet-incubation-chi-manual.pdf
${project.build.directory}/website-intermediate/eclipse-escet-incubation-chi-manual.pdf
</outputFile>
<backend>pdf</backend>
<sourceHighlighter>coderay</sourceHighlighter>
......@@ -94,7 +93,6 @@
</attributes>
</configuration>
</execution>
<execution>
<id>generate-website</id>
<phase>generate-resources</phase>
......@@ -102,7 +100,7 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>${project.build.directory}/website/index.html</outputFile>
<outputFile>${project.build.directory}/website-intermediate/index.html</outputFile>
<backend>html5</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<logHandler>
......@@ -117,6 +115,7 @@
<icons>font</icons>
<toc>left</toc>
<toclevels>2</toclevels>
<sectanchors>true</sectanchors>
<html-output>true</html-output>
<website-output>true</website-output>
</attributes>
......@@ -125,36 +124,109 @@
</executions>
</plugin>
<!-- Split single-page HTML to multi-page HTML. -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<mainClass>
org.eclipse.escet.common.asciidoc.html.multipage.AsciiDocMultiPageHtmlSplitter
</mainClass>
<includePluginDependencies>true</includePluginDependencies>
<includeProjectDependencies>true</includeProjectDependencies>
</configuration>
<executions>
<execution>
<id>eclipse-help-multi-html-split</id>
<phase>generate-resources</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/asciidoc</argument>
<argument>${project.build.directory}/eclipse-help-intermediate/index.html</argument>
<argument>${project.build.directory}/eclipse-help</argument>
<argument>--eclipse-help</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>website-multi-html-split</id>
<phase>generate-resources</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/asciidoc</argument>
<argument>${project.build.directory}/website-intermediate/index.html</argument>
<argument>${project.build.directory}/website</argument>
<argument>--website</argument>
</arguments>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.common.asciidoc</artifactId>
<version>${project.version}</version>
<type>eclipse-plugin</type>
</dependency>
<dependency>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.common.java</artifactId>
<version>${project.version}</version>
<type>eclipse-plugin</type>
</dependency>
<dependency>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.common.app.framework</artifactId>
<version>${project.version}</version>
<type>eclipse-plugin</type>
</dependency>
</dependencies>
</plugin>
<!-- Copy non-HTML files from intermediate output folders to final output folders. -->
<plugin>
<!-- Generate Table of Contents (TOC) for Eclipse help. -->
<groupId>com.bsiag.geneclipsetoc</groupId>
<artifactId>geneclipsetoc-maven-plugin</artifactId>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>copy-intermediate-to-final</id>
<phase>generate-resources</phase>
<goals>
<goal>geneclipsetoc</goal>
<goal>run</goal>
</goals>
<configuration>
<outputTocFile>${project.build.directory}/eclipse-help/toc.xml</outputTocFile>
<sourceFolder>${basedir}</sourceFolder>
<pages>
<page>target/eclipse-help/index.html</page>
</pages>
<target>
<copy todir="${project.build.directory}/eclipse-help" verbose="true">
<fileset dir="${project.build.directory}/eclipse-help-intermediate">
<exclude name="**/*.html" />
</fileset>
</copy>
<copy todir="${project.build.directory}/website" verbose="true">
<fileset dir="${project.build.directory}/website-intermediate">
<exclude name="**/*.html" />
</fileset>
</copy>
</target>
</configuration>
</execution>
</executions>
</plugin>
<!-- Package the Eclipse help contents in the plugin. -->
<plugin>
<!-- Package the eclipse help contents in the plugin -->
<groupId>org.eclipse.tycho</groupId>
<artifactId>tycho-packaging-plugin</artifactId>
<configuration>
<additionalFileSets>
<fileSet>
<!-- Put in same dir within JAR ensuring doc will work in runtime instance and RCP. -->
<prefix>target/eclipse-help/</prefix>
<directory>${project.build.directory}/eclipse-help/</directory>
<includes>
<include>**/*</include>
......@@ -164,6 +236,7 @@
</configuration>
</plugin>
<!-- Assemble website ZIP file. -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
......
<!--
Copyright (c) 2021 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<!--
Dummy TOC file.
A real one is generated and packaged during the build.
This one is only present to silence warnings in the development environment, for plugin.xml.
-->
<toc label="Chi dummy TOC" topic="chi_dummy_toc_does_not_exist.html"/>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment