After using checkmake for a while, I was looking through the repo trying to find a detailed description of each rule but without much success. I am interested in this documentation and example Makefiles that trigger failures because I wanted to demonstrate in another project how checkmake can catch regressions in Makefiles: rook/rook#15683 (comment)
I found that checkmake --list-rules lists the rules but without a detailed description.
In order to understand the rules and what triggers them to fail, I had to read the test code under the respective subdirectory of https://github.com/mrtazz/checkmake/tree/main/rules.
I would therefore consider it very helpful to have md files under https://github.com/mrtazz/checkmake/tree/main/docs that document the rules completely.
This issue might be or less the same as #107, but I wanted to raise it in my own words nonetheless.
If this is deemed useful by @mrtazz , I'd be happy to help to contribute such a doc.
After using
checkmakefor a while, I was looking through the repo trying to find a detailed description of each rule but without much success. I am interested in this documentation and example Makefiles that trigger failures because I wanted to demonstrate in another project how checkmake can catch regressions in Makefiles: rook/rook#15683 (comment)I found that
checkmake --list-ruleslists the rules but without a detailed description.In order to understand the rules and what triggers them to fail, I had to read the test code under the respective subdirectory of https://github.com/mrtazz/checkmake/tree/main/rules.
I would therefore consider it very helpful to have md files under https://github.com/mrtazz/checkmake/tree/main/docs that document the rules completely.
This issue might be or less the same as #107, but I wanted to raise it in my own words nonetheless.
If this is deemed useful by @mrtazz , I'd be happy to help to contribute such a doc.