Comments in Model INI files?

Hi folks,

Can I ask if it's possible to add comments to model.ini files? I'm new to Deviation and it would be a huge help if I could add comments to the various mixers to help me understand them more easily. Mainly what I want to do is document the input source, the switch modifiers, and what each output channel relates to for that model.

Apologies if this has been asked before, I had a look but couldn't find if this was possible.

Cheers,

Ross

I have also identified this need, specifically around the assignment of icons.

Perhaps we should start with document starting with the keys without obvious names and those not written by or settable from the GUI?

It is not as easy as it seems. Allowing comments is easy, but as FDR noticed they were not rewritten when the config has changed and is saved.
So for keeping the comments we would have to parse the original file while writing to it (not possible because we could write a position behind the read pointer dependent of the values to be written), we would keep the old file for reading and write the new config to a new file (not possible because the file system used does not allow file creating - possible solution: copy to a dummy file) or we have to save the comments somewhere in the RAM (could be hard on limited hardware like 7e).
And we would have to keep the position of the comment as well - this could be done because the order of the values written is constant.

Another idea I had earlier, but have not really thought about: a regular field in the gui where I can write individual text and which is saved with the model or perhaps in addition to the modelXX.ini (say "hintsXX.ini") - the second could work also on limited hardware because the text must not be kept in RAM. But every file costs 4kB of flash (even if empty) - can lead to a lack of resources too.

PhracturedBlue wrote: As rbe says, supporting comments is just not realistic here. Ifyou are modifying an ini file by hand, you are by definition an advanced user. Documenting the ini file is probably a worthy goal to help those people.

I agree, it is not needed on the TX but a document would help.