mrtazz
document the rules in detail
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: https://github.com/rook/rook/pull/15683#issuecomment-2857985236
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.
I think that super makes sense. I'm thinking whether the route of making them markdown files in the docs/ folder is the best way to go though. The folder currently mostly has development documentation. And while using the tool one doesn't necessarily have the repo checked out. So maybe it would be nicer to either have a more descriptive output of --list-rules or maybe even a checkmake describe command to output a more detailed description of a specific rule.
Another idea that I kinda like is making it part of the man page. Or having it be its own man page potentially (maybe man 5 checkmake or man 7 checkmake could make sense here). That way the information would be in the normal expected documentation path on the system.
@mrtazz , I agree that it is best to keep such user-facing documentation separate from the development docs. I'll start out with some updates to the --list-rulesoutput and can think about manpages afterwards.