Commit aa0917e9 authored by Yuri Blankenstein's avatar Yuri Blankenstein
Browse files

#8 Adding incubation, trademarks and legal notes

parent 419145cf
Pipeline #4518 passed with stage
in 0 seconds
......@@ -10,22 +10,22 @@
include::docs/_attributes.asciidoc[]
= Contributing to Eclipse TRACE4CPS
= pass:normal[Contributing to {trace}]
This guide provides all necessary information to enable https://www.eclipse.org/projects/dev_process/=2_3_1_Contributors_and_Committers[contributors and committers^] to contribute to Eclipse TRACE4CPS.
This guide provides all necessary information to enable https://www.eclipse.org/projects/dev_process/=2_3_1_Contributors_and_Committers[contributors and committers^] to contribute to {trace}.
NOTE: Contributions are always welcome!
== Eclipse TRACE4CPS
== pass:normal[{trace}]
Eclipse TRACE4CPS is a customizable, domain-independent and source-independent Gantt chart viewer with mathematically-founded analysis support.
Eclipse TRACE4CPS supports the visualization of activities on resources as a function of time (Gantt charts), as well as the visualization of continuous signals.
Eclipse TRACE4CPS also supports several analysis techniques to identify bottlenecks, check formally-specified (performance) properties, and analyze resource usage.
A key feature of Eclipse TRACE4CPS is the ability to configure the identification, selection and visualization of such information to match any specific application domain.
{trace} is a customizable, domain-independent and source-independent Gantt chart viewer with mathematically-founded analysis support.
{trace} supports the visualization of activities on resources as a function of time (Gantt charts), as well as the visualization of continuous signals.
{trace} also supports several analysis techniques to identify bottlenecks, check formally-specified (performance) properties, and analyze resource usage.
A key feature of {trace} is the ability to configure the identification, selection and visualization of such information to match any specific application domain.
For more information, see:
- Project home: https://www.eclipse.org/trace4cps
- Project home: https://projects.eclipse.org/projects/technology.trace4cps
- Website: https://eclipse.org/trace4cps
== Developer resources
......@@ -69,7 +69,7 @@ For more information, please see the Eclipse Committer Handbook:
== How to contribute
The Eclipse TRACE4CPS source code can be found https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps[here].
The {trace} source code can be found https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps[here].
How to build and setup a development environment can be found link:docs/developing.asciidoc[here].
......
......@@ -10,14 +10,14 @@
include::docs/_attributes.asciidoc[]
= Notices for Eclipse TRACE4CPS
= pass:normal[Notices for {trace}]
This content is produced and maintained by the Eclipse TRACE4CPS project.
This content is produced and maintained by the {trace} project.
* Project home: https://www.eclipse.org/trace4cps
* Project home: https://projects.eclipse.org/projects/technology.trace4cps
* Website: https://www.eclipse.org/trace4cps
* Issue tracker: https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps/-/issues
* Downloads: https://download.eclipse.org/trace4cps
* Downloads: https://download.eclipse.org/trace4cps/
* Archived downloads: https://archive.eclipse.org/trace4cps
* Forum: TODO
* Developers mailing list: https://accounts.eclipse.org/mailing-list/trace4cps-dev
......@@ -26,7 +26,7 @@ This content is produced and maintained by the Eclipse TRACE4CPS project.
== Trademarks
Eclipse TRACE4CPS and TRACE4CPS are trademarks of the Eclipse Foundation. Eclipse,
{trace} and TRACE4CPS are trademarks of the Eclipse Foundation. Eclipse,
and the Eclipse Logo are registered trademarks of the Eclipse Foundation.
Other names may be trademarks of their respective owners.
......@@ -60,7 +60,7 @@ JFreeChart (1.6.0-RC1)
* License: LGPL 2.1
* Project: https://www.jfree.org/jfreechart/
* Source: https://github.com/Yuri-Blankenstein-TNO/jfreechart/tree/v1.6.0_RC1
* Source: https://github.com/Yuri-Blankenstein-TNO/jfreechart/releases/tag/v1.6.0_RC1
== Cryptography
......
......@@ -10,14 +10,14 @@
include::docs/_attributes.asciidoc[]
= Eclipse TRACE4CPS
= pass:normal[{trace}]
Welcome to the Eclipse TRACE4CPS repository!
Welcome to the {trace} repository!
Eclipse TRACE4CPS is a customizable, domain-independent and source-independent Gantt chart viewer with mathematically-founded analysis support.
Eclipse TRACE4CPS supports the visualization of activities on resources as a function of time (Gantt charts), as well as the visualization of continuous signals.
Eclipse TRACE4CPS also supports several analysis techniques to identify bottlenecks, check formally-specified (performance) properties, and analyze resource usage.
A key feature of Eclipse TRACE4CPS is the ability to configure the identification, selection and visualization of such information to match any specific application domain.
{trace} is a customizable, domain-independent and source-independent Gantt chart viewer with mathematically-founded analysis support.
{trace} supports the visualization of activities on resources as a function of time (Gantt charts), as well as the visualization of continuous signals.
{trace} also supports several analysis techniques to identify bottlenecks, check formally-specified (performance) properties, and analyze resource usage.
A key feature of {trace} is the ability to configure the identification, selection and visualization of such information to match any specific application domain.
Handy links:
......
......@@ -21,3 +21,7 @@
// Admonition symbols (e.g. 'warning' symbol).
:icons: font
// If we use this attribute in a heading, we need to encapsulate the whole heading text in pass:normal[...] macro due to bug
// https://github.com/asciidoctor/asciidoctor/issues/1173 (Replacements in an attribute value not substituted in headings (section titles))
:trace: Eclipse TRACE4CPS
......@@ -13,7 +13,7 @@ include::_attributes.asciidoc[]
[[dev-env-setup]]
== Development environment setup
Follow these instructions to set up an Eclipse TRACE4CPS development environment.
Follow these instructions to set up an {trace} development environment.
indexterm:[installer]
indexterm:[oomph]
......@@ -58,7 +58,7 @@ To create a development environment:
*** For _Catalog_, choose _Eclipse Projects_.
*** For _Resource URIs_, enter `+https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps/-/raw/develop/TRACE4CPS.setup+` and make sure there are no spaces before or after the URL.
*** Click btn:[OK].
** Check the checkbox for _Eclipse TRACE4CPS_, from the big list.
** Check the checkbox for _{trace}_, from the big list.
It is under _Eclipse Projects_ / _<User>_.
** At the bottom right, select the _develop_ stream.
** Click btn:[Next].
......@@ -66,8 +66,8 @@ To create a development environment:
** Enable the _Show all variables_ option to show all options.
** Choose a _Root install folder_ and _Installation folder name_.
The new development environment will be put at `<root_installation_folder>/<installation_folder_name>`.
** Fill in the _Eclipse TRACE4CPS Git clone URL_:
*** Committers with write access to the Eclipse TRACE4CPS official GitLab repository can use the default URL `+https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps.git+`.
** Fill in the _{trace} Git clone URL_:
*** Committers with write access to the {trace} official GitLab repository can use the default URL `+https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps.git+`.
*** Contributors can use the same URL, but as they don't have write access, they will not be able to push to the remote repository.
They can instead make a fork of the official Git repository.
Then they can fill in the URL of their clone instead, i.e. `+https://gitlab.eclipse.org/<username>/<cloned_repo_name>.git+`, with `<username>` replaced by their Eclipse Foundation account username, and `<cloned_repo_name>` replaced by the name of the cloned repistory, which defaults to `trace4cps`.
......
......@@ -16,7 +16,7 @@ include::dev-env-setup.asciidoc[]
== Building with Maven
To build Eclipse TRACE4CPS with Maven execute the following command in the root:
To build {trace} with Maven execute the following command in the root:
Linux :: `./build.sh`
Windows :: `.\build.cmd`
......@@ -59,8 +59,8 @@ The following is an overview:
* `jfreechart/org.jfree.jfreechart`: OSGi wrapper around the JFreeChart visualization library
* `releng/legal-defaults`: contains files with defaults for legal stuff.
* `releng/org.eclipse.trace4cps.configuration`: The master pom.xml file, containing the build configuration.
* `releng/org.eclipse.trace4cps.repository`: Standard update site for Eclipse TRACE4CPS
* `releng/org.eclipse.trace4cps.target`: Standard Eclipse target platform configurations for Eclipse TRACE4CPS
* `releng/org.eclipse.trace4cps.repository`: Standard update site for {trace}
* `releng/org.eclipse.trace4cps.target`: Standard Eclipse target platform configurations for {trace}
* `temporallogic/org.eclipse.trace4cps.tl`: Grammar definition of temporal-logic DSL
* `temporallogic/org.eclipse.trace4cps.tl.cmd`: Module for a command-line trace verification tool
* `temporallogic/org.eclipse.trace4cps.tl.ide`: Default Xtext IDE module
......
......@@ -12,7 +12,7 @@
-->
<feature
id="org.eclipse.trace4cps.common.jfreechart.feature"
label="TRACE4CPS Chart Feature"
label="TRACE4CPS Chart Feature (Incubation)"
version="0.1.0.qualifier"
provider-name="Eclipse TRACE4CPS"
plugin="org.eclipse.trace4cps.branding"
......
......@@ -12,25 +12,25 @@
-->
<site>
<feature id="org.eclipse.trace4cps.feature">
<category name="org.eclipse.trace4cps"/>
<category name="org.eclipse.trace4cps.category"/>
</feature>
<feature id="org.eclipse.trace4cps.feature.source">
<category name="org.eclipse.trace4cps"/>
<category name="org.eclipse.trace4cps.category"/>
</feature>
<feature id="org.eclipse.trace4cps.common.jfreechart.feature">
<category name="org.eclipse.trace4cps.jfreechart"/>
<category name="org.eclipse.trace4cps.common.category"/>
</feature>
<feature id="org.eclipse.trace4cps.common.jfreechart.feature.source">
<category name="org.eclipse.trace4cps.jfreechart"/>
<category name="org.eclipse.trace4cps.common.category"/>
</feature>
<bundle id="org.jfree.jfreechart">
<category name="org.eclipse.trace4cps.jfreechart"/>
<category name="org.eclipse.trace4cps.common.category"/>
</bundle>
<bundle id="org.jfree.jfreechart.source">
<category name="org.eclipse.trace4cps.jfreechart"/>
<category name="org.eclipse.trace4cps.common.category"/>
</bundle>
<category-def name="org.eclipse.trace4cps" label="Eclipse TRACE4CPS (Incubation)"/>
<category-def name="org.eclipse.trace4cps.jfreechart" label="Eclipse TRACE4CPS JFreeChart (Incubation)">
<category name="org.eclipse.trace4cps"/>
<category-def name="org.eclipse.trace4cps.category" label="Eclipse TRACE4CPS (Incubation)"/>
<category-def name="org.eclipse.trace4cps.common.category" label="Eclipse TRACE4CPS Common (Incubation)">
<category name="org.eclipse.trace4cps.category"/>
</category-def>
</site>
////
// Copyright (c) 2021 Contributors to the Eclipse Foundation
//
// This program and the accompanying materials are made
// available under the terms of the Eclipse Public License 2.0
// which is available at https://www.eclipse.org/legal/epl-2.0/
//
// SPDX-License-Identifier: EPL-2.0
////
include::_initCommon.adoc[]
indexterm:[legal]
[[legal]]
== Legal
The material in this documentation is Copyright (c) 2021 Contributors to the Eclipse Foundation.
Eclipse TRACE4CPS and TRACE4CPS are trademarks of the Eclipse Foundation.
Eclipse, and the Eclipse Logo are registered trademarks of the Eclipse Foundation.
Other names may be trademarks of their respective owners.
*License*
The Eclipse Foundation makes available all content in this document ("Content").
Unless otherwise indicated below, the Content is provided to you under the terms of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0/
For purposes of the EPL-2.0 License, "Software" will mean the Content.
If you did not receive this Content directly from the Eclipse Foundation, the Content is being redistributed by another party ("Redistributor") and different terms and conditions may apply to your use of any object code in the Content.
Check the Redistributor's license that was provided with the Content.
If no such license exists, contact the Redistributor.
Unless otherwise indicated below, the terms and conditions of the EPL-2.0 License still apply to any source code in the Content and such source code may be obtained at link:https://www.eclipse.org[].
......@@ -11,12 +11,12 @@
include::_initCommon.adoc[]
[[release-notes]]
== Release Notes
== pass:normal[{trace}^TM^ release notes]
The release notes of {trace} are listed below, in reverse chronological order.
The release notes of {trace}^TM^ are listed below, in reverse chronological order.
[[release-notes-v0.1]]
=== pass:normal[{trace} v0.1]
=== Version 0.1
The first release of the {trace} project.
The first release of the {trace}^TM^ project.
This version is a port of https://esi.nl/research/output/tools/trace[ESI TRACE v2.0] that is prepared for its release to the Eclipse foundation.
......@@ -16,23 +16,23 @@ include::_initCommon.adoc[]
:!table-caption:
:xrefstyle: short
= {trace}
= pass:normal[{trace}^TM^]
*{trace}* is a *customizable, domain-independent and source-independent Gantt chart viewer* with mathematically-founded analysis support.
*{trace}^TM^* is a *customizable, domain-independent and source-independent Gantt chart viewer* with mathematically-founded analysis support.
{trace} supports the visualization of activities on resources as a function of time (Gantt charts), as well as the visualization of continuous signals.
{trace} also supports several analysis techniques to identify bottlenecks, check formally-specified (performance) properties, and analyze resource usage.
A key feature of {trace} is the ability to configure the identification, selection and visualization of such information to match any specific application domain.
[WARNING]
====
The {trace} project is currently in the link:https://wiki.eclipse.org/Development_Resources/Process_Guidelines/What_is_Incubation[Incubation Phase].
The {trace}^TM^ project is currently in the link:https://wiki.eclipse.org/Development_Resources/Process_Guidelines/What_is_Incubation[Incubation Phase].
image::{imgsdir}/eclipse-incubation.png[width=300]
====
== Visualization and analysis of concurrent system activities
{trace} helps us to understand complicated behavior over time for all kinds of systems through its domain-independent capabilities for visualizing and analyzing concurrent activities that are encoded in execution traces.
{trace}^TM^ helps us to understand complicated behavior over time for all kinds of systems through its domain-independent capabilities for visualizing and analyzing concurrent activities that are encoded in execution traces.
{trace} supports claims on resources, events, dependencies, and continuous signals.
<<fig-trace>> shows a typical {trace} Gantt chart of an application that iteratively executes activities A-G.
......@@ -52,11 +52,11 @@ An example is a situation in which many concurrent activities share resources.
Unforeseen interactions may arise due to the specific timing of the activities.
Moreover, if the timing of the activities changes (e.g. due to an upgrade to the computational platform), the interactions may also change, which could result in significantly different behavior.
Insight into the hows and whys of a system’s behavior over time is of paramount importance for making effective (design) choices and trade-offs in all phases of the system lifecycle, from the design of a new system to the maintenance of an old legacy system.
{trace} can help with this.
{trace}^TM^ can help with this.
== Execution traces to capture behavior over time
{trace} works with execution traces.
{trace}^TM^ works with execution traces.
These capture (a single) system behavior over time.
An execution trace contains time-stamped data for claims, events and signals.
{trace} extends this with concepts from the Y-chart paradigm and a number of user-defined attributes (e.g. the name of the activity) in order to be tailored to a specific problem domain.
......@@ -83,7 +83,7 @@ To provide feedback on the system under analysis (star-2 in <<fig-ychart>>), {tr
== Visualization and analysis of execution traces
{trace} provides insights into the system dynamics of all kinds of systems through the visualization and analysis of execution traces (<<fig-workflow>>).
{trace}^TM^ provides insights into the system dynamics of all kinds of systems through the visualization and analysis of execution traces (<<fig-workflow>>).
{trace}' Gantt chart view offers coloring, grouping and filtering options.
This visualization alone is already very powerful and can bring quick insights into the system dynamics.
{trace} also provides several analysis methods, which sets it apart from other Gantt-chart visualization tools.
......@@ -114,7 +114,7 @@ Resource-usage analysis::
image::{imgsdir}/workflow.png[width=414]
[[installation]]
== Installation of {trace}
== pass:normal[Installation of {trace}^TM^]
The {trace} P2 update site contains all plugins and features, for easy integration into OSGi-based applications.
......@@ -194,4 +194,6 @@ TIP: Once the {trace} feature is <<installation, installed>>, the Eclipse Help m
International Journal on Software Tools for Technology Transfer, 2016.
doi:10.1007/s10009-016-0436-z
include::_release-notes.adoc[]
\ No newline at end of file
include::_release-notes.adoc[]
include::_legal.adoc[]
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