GitLab

[Comment about the rail diagram application docs describing the general application options:]

• @ddennis started a discussion: (+1 comment)

  should we move this to some general place, rather than duplicating it for every application? maybe to the use part of the project documentation?

Slightly deeper searching, I found that many applications just say

=== Options

Besides the general application options, this application has the following options:

[[description of the local application options]]

But there is no link at "general application options", and if you look for "general application" or "application option", you find lots of uses, and a description in

chi/org.eclipse.escet.chi.documentation/asciidoc/tool-manual/command-line.asciidoc
33:=== General application options

For "general options" there is just one definition (recently added and the cause for this issue):

releng/org.eclipse.escet.releng.dev.documentation/asciidoc/rail/commandline.asciidoc
23:=== General options

So historically, the general application options seem to be documented in Chi only which is a weird spot to say the least. The rail application recently added another description.

There doesn't seem to be a description of the general application options for CIF tools at all. To address this, the following steps seem useful

• Check that common "general application options (for CIF?)" is indeed always the same set of options.
• Decide where CIF should document its common general application options, for example it could be done in
  • Some central spot in the CIF documentation.
  • With every tool separately.
  • In the overall ESCET description, then the Chi and rail descriptions could also point to that (after checking they talk about the same set of options)
  • As the previous, but put the description in the app.framework documentation.
• Link from all applications to that general spot.

Tooldef seems not to even mention these options, but then again it's not an app framework application afaik, so that's ok it seems.