Clarifications in the Compiler Flag Documentation

[Francesco Casella]

The web page ​https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/omchelptext.html lists all compiler flags, and is automatically generated from omc help info.

The situation has improved dramatically once #2913 was addressed. However, there are four things that still need to be fixed.

1. The documentation gives -d and --debug as debug flags. However, in the page there are still three references to +d, which are very confusing because it is not clear whether that is a separate flag with different effects or not. Please always use the same notation -d everywhere. You may also mention in the documentation that the +d notation is deprecated but can still be found in existing code

2. The documentation ​https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/omchelptext.html#omcflag-debug-section explains how to set up the -d flag. However, there are no examples. I would suggest to add one or two, and at least one where multiple flags are set and some are reset, for better clarity.

3. The documentation of --preOptModules, --initOptModules and --postOptModules does not contain any example, so it is not clear how one can actually set the options that are listed there. I would suggest to add a couple of examples from which it is clear what the syntax is.

4. The new flags introduced in ​https://github.com/OpenModelica/OMCompiler/pull/282 are not documented at all, please add the documentation of --forceRecommendedOrdering and also add the documentation about += and -= to --preOptModules, and --postOptModules. BTW, can this also be used with --initOptModules, or should a special section dedicated to flags used in initOptModules be also introduced in the documentation?

[Lennart Ochel]

I will improve the documentation a bit.

Please note that the documentation already contains all the default values. E.g. --preOptModules is described ​here including the default value and all valid options.

The flag --forceRecommendedOrdering is renamed into --defaultOptModulesOrdering and briefly described ​here.

Moreover I suggest to remove a bunch of flags, to make the usage of omc more consistent and less complicated (see #3568#comment:9).

[Francesco Casella]

Replying to lochel:

Please note that the documentation already contains all the default values. E.g. --preOptModules is described ​here including the default value and all valid options.

This is true, but it is not clear how you apply the string list to the flag - do you need an equality sign? Can you have spaces beween the flag and the string? Has the string to be quoted? A small example would suffice, following the old tradion of man pages.

[Martin Sjölund]

Milestone pushed to 1.9.5

[Martin Sjölund]

Milestone renamed

[Martin Sjölund]

Ticket retargeted after milestone closed

[Martin Sjölund]

Milestone moved to 1.12.0 due to 1.11.0 already being released.

[Francesco Casella]

Milestone moved to 1.13.0 due to 1.12.0 already being released.

[Francesco Casella]

Rescheduled to 1.14.0 after 1.13.0 releasee

[Francesco Casella]

Releasing 1.14.0 which is stable and has many improvements w.r.t. 1.13.2. This issue is rescheduled to 1.16.0

[Francesco Casella]

Retargeted to 1.17.0 after 1.16.0 release

[Francesco Casella]

Retargeted to 1.18.0 because of 1.17.0 timed release.

[Francesco Casella]

Ticket retargeted after milestone closed