In making changes to project settings for a Crossworks project, I was struck that it would be handy to have some sort of mechanism to add a comment associated with the setting. Most everyone faces the situation of revisiting code (or inheriting code from someone else) and wondering why a particular setting was chosen.
A few example scenarios are:
- setting a particular C file to compile as ARM (not Thumb) because it contains an ISR
- adding a particular preprocessor define because some constituent library needs it
- if on an older target using JTAG, there might be particular non-obvious before and after bit settings
- The most recent incident was where I had to add "-I./pathto/" to asm_additional_options (Additional Assembler Options) in order to make some 3rd party library code compile as-is, and the reason for doing this would certainly not be apparent to anyone inheriting the project.
In source code, Makefiles, linker scripts, etc., one can add comments, but I don't believe this is as straightforward in a .hzp project file.
Storing the comment seems the easy part; the existing XML .hzp format would seem easily extensible to store an extra tag.
How the Project Properties UI would display these comments to the user and allow the user to add/edit them is more ambiguous.
Anyway, it seemed worth at least floating the idea to see if there was interest.
Please sign in to leave a comment.