eclipse-gemoc / eclipse-gemoc/gemoc-studio-modeldebugging

Incomplete documentation about Trace generator or remove trace generator feature ?

Open
#69 0 comments 0 reactions 0 assignees View on GitHub
documentation question refactoring
Dominant language
Java
Stars
6
Forks
14
PR merge metrics
No merged PRs in 30d

Description

The Trace generator documentation is currently incomplete
(see http://download.eclipse.org/gemoc/docs/nightly/userguide-lw-provide-language-with-tools.html#defining-multidimensional-trace-project-section and its source https://github.com/eclipse/gemoc-studio-modeldebugging/blob/master/trace/generator/plugins/org.eclipse.gemoc.trace.gemoc.ui/docs/asciidoc/user_lw_GenerateTraceMetamodel.asciidoc )

However, when discussing with @d-leroy, it appears that the generic trace is as efficient as a language specific one. (When writing https://www.sciencedirect.com/science/article/pii/S0164121217302765 they decided to not include the language specific one due to small performance difference with the generic one)
Does it make sense to keep both the generic trace and the generator ? is there any reason to keep the code of the generator ?

We should decide if we
* a/ keep the generator but then we need to complement the documentation (including comparison with the generic one)
* b/ or simply remove the generator (then update the documentation but only about the use of the generic trace in the modeling workbench, not about generating it and compare it with the generic one)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.