s2e-core
s2e-core copied to clipboard
Align INI File Comment Syntax with Common Standards: Replace `//` with `;`
Details
- Currently, the INI files in S2E use
//
to denote comments. However, as per the INI file standards, it is more common to use;
at the beginning of a comment line. - There are hardly any other examples of INI files that recognize
//
as a comment, which is confusing, so I would like to conform to the;
style. - This becomes problematic when using libraries such as
configparser
in Python for post-analysis of simulation results. The library expects;
to start comment lines and fails to parse files commented with//
.
Closing conditions
- [ ] All existing INI files in the repository have been updated to use
;
for comments. - [ ] In the future, I want to issue warnings for comments starting with
//
, and eventually treat//
comments as errors in a major update.
Supplementary information
NA
Note
- TBW
Related issues
https://github.com/ut-issl/s2e-core/issues/254