cil-project / cil

C Intermediate Language
Other
348 stars 86 forks source link

Ptanal polishing #13

Open cspiel opened 10 years ago

cspiel commented 10 years ago

@kerneis: as promised - documentation updates

kerneis commented 10 years ago

Thanks @cspiel. This is a good starting point. I'll tweak your patches and merge them. Comments:

(There is currently no facility for clearing internal state, so \t{Ptranal.analyze_file} should only be called once.)

As a matter of fact, the ptanal-fixes branches has added such a functionality. I will amend the doc accordingly.

Ptranal.olf_backend

This option should not be documented (and it is, in fact, not exposed), because it does not switch the backend. More precisely, for ugly technical reasons related to typing, the choice of backend must be done when the module is loaded: the only available information at that point is the command-line, which is parsed, setting this reference, and then making tricks with first class modules to load the right one. Changing the reference later does not affect which module is used.

cspiel commented 10 years ago

@kerneis, I did not know that the "multi-entry" feature of Ptranal was ready for prime time. Nice to learn!

So, please kick out my scribbling about Ptranal.olf_backend and instead add Ptranal.initialize.