id	summary	reporter	owner	description	type	status	priority	milestone	component	version	resolution	keywords	cc
3572	Clarifications in the Compiler Flag Documentation	Francesco Casella	Lennart Ochel	"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?"	defect	accepted	high		*unknown*				andrea.bartolini@…