Opened 12 years ago

Closed 9 years ago

Last modified 9 years ago

#2212 closed defect (fixed)

Description of flags missing

Reported by: Francesco Casella Owned by: somebody
Priority: high Milestone: 1.9.4
Component: Command Prompt Environment Version: trunk
Keywords: Cc: openmodelicadevelopers@…

Description

Typing omc +help=debug > options.txt generates a list of debugging options. Many of them do not have any description.

Either they are obsolete, and should be removed, or they should get a proper (though short) description.

Change History (19)

comment:1 by Per Östlund, 12 years ago

Cc: openmodelicadevelopers@… added
Milestone: Future1.9.0

I removed some unused debug flags, but there's still lots of undocumented ones. Adding cc to the developers mailing list to get peoples attention, we should fix this before the release. If no one knows what a debug flag does we should probably just remove it.

I also removed the unused configuration flag +paramsStruct. The only configuration flag which does not have a description now is the +modelicaOutput flag. Using it causes the compiler to print out a message saying that the flag is deprecated, but it's also used in XMLDump.dumpExp2. Does anyone have a good reason for keeping this flag?

comment:2 by Lennart Ochel, 12 years ago

The following list contains all omc debug-flags without any description from omc 1.9.0 beta4+dev (r16162):

beforefixmodout
blt
checkDAECrefType
daedump
daedump2
daedumpdebug
daedumpgraphv
dump
dumpIH
dumpInit
dumptr
env
evalparam
events
execFiles
execHash
failtraceJac
flatmodelica
frontend-inline-euler
generateCodeCheat
graphviz
info
jacdump
jacdump2
jacdumpeqn
jacobian
openmp
paramdlowdump
patternmAllInfo
patternmSkipFilterUnusedBindings
patternmSkipMCDCE
patternmSkipMoveLastExp
perfTimes
pthreads
recconst
relidx
sei
static
tcvt
transformsbeforedump
usedep

comment:3 by Lennart Ochel, 12 years ago

Things are going on – great! The number of undocumented debug-flags has been decreased to 33! The following flags needs to be removed or documented (1.9.0 beta4+dev (r16180)):

beforefixmodout        
blt                    
checkDAECrefType       
daedump                
daedump2               
daedumpdebug           
daedumpgraphv          
dump                   
dumpIH                 
dumptr                 
env                    
evalparam              
events                 
execFiles              
execHash               
flatmodelica           
frontend-inline-euler  
generateCodeCheat      
graphviz               
info                   
paramdlowdump          
patternmAllInfo        
patternmSkipFilterUnusedBindings 
patternmSkipMCDCE      
patternmSkipMoveLastExp 
perfTimes              
recconst               
relidx                 
sei                    
static                 
tcvt                   
transformsbeforedump   
usedep                 

comment:4 by Per Östlund, 12 years ago

I have now decreased the number of undocumented flags further in r16190. The following debug flags have been removed because they were unused, used incorrectly, or just because I felt like removing them:

env
info
beforefixmodout
flatmodelica
daedump
daedump2
daedumpdebug
blt
tcvt
dumptr
dumpIH
recconst
sei

If someone (i.e. MathCore) is still using one of these, just put them back again and add a description. I also removed the modelicaOutput flag, let's see if anyone complains.

The following debug flags still needs descriptions:

execFiles              
execHash
paramdlowdump 
patternmAllInfo        
patternmSkipFilterUnusedBindings 
patternmSkipMCDCE      
patternmSkipMoveLastExp 

Also, some optimizations modules needs descriptions too, search for "DESCRIBE ME" in Flags.mo.

comment:5 by Martin Sjölund, 12 years ago

The patternm flags are used mainly to refactor the compiler :)

comment:6 by Lennart Ochel, 12 years ago

The following list contains all (9) omc debug-flags without any description from omc 1.9.0 beta4+dev (r16350):

execFiles
execHash
frontendInlineEuler
paramdlowdump
patternmAllInfo
patternmSkipFilterUnusedBindings
patternmSkipMCDCE
patternmSkipMoveLastExp
relidx

in reply to:  6 comment:7 by Martin Sjölund, 12 years ago

Remaining after r16355:

execFiles
execHash
frontendInlineEuler
paramdlowdump
relidx

comment:8 by Jens Frenkel, 12 years ago

Remaining after r16357:

execFiles
execHash
frontendInlineEuler
relidx

comment:9 by Willi Braun, 12 years ago

Remaining after r16358:

execFiles
execHash
frontendInlineEuler

comment:10 by Martin Sjölund, 12 years ago

I will fix the remaining ones.

comment:11 by Per Östlund, 12 years ago

The following preOptModules/postOptModules options also need to be translated:

preOptModules:

inlineArrayEqn
removeEqualFunctionCalls
expandDerOperator

postOptModules:

removeEqualFunctionCalls
inlineArrayEqn
relaxSystem
dumpComponentsGraphStr

comment:12 by Martin Sjölund, 12 years ago

Summary: Description of debug flags missingDescription of flags missing

r16361 fixed the debug-flags.

comment:13 by Martin Sjölund, 11 years ago

Milestone: 1.9.01.9.1

Postponed until 1.9.1

comment:14 by Martin Sjölund, 10 years ago

Milestone: 1.9.11.9.2

This ticket was not closed for 1.9.1, which has now been released. It was batch modified for milestone 1.9.2 (but maybe an empty milestone was more appropriate; feel free to change it).

comment:15 by Martin Sjölund, 10 years ago

Milestone: 1.9.21.9.3

Milestone changed to 1.9.3 since 1.9.2 was released.

comment:16 by Martin Sjölund, 9 years ago

Milestone: 1.9.31.9.4

Moved to new milestone 1.9.4

comment:17 by Francesco Casella, 9 years ago

Resolution: fixed
Status: newclosed

The online documentation at https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/omchelptext.html#omcflag-debug-section describes all options except patternmSkipFilterUnusedBindings, which is definitely arcane and off by default. No big deal.

Therefore, I am closing the ticket.

comment:18 by Martin Sjölund, 9 years ago

Milestone: 1.9.41.9.4-1.9.x

Milestone renamed

comment:19 by Martin Sjölund, 9 years ago

Milestone: 1.9.4-1.9.x1.9.4

Milestone renamed

Note: See TracTickets for help on using tickets.