Self documenting Makefile

[rickard-von-essen]

Make the Makefile self documented allowing a developer to understand the targets by running make help.

Example:

I'll add more documentation if I get a 👍.

Optionally we can change to .PHONY: help if that don't brake anything important.

[cbednarski]

This looks super cool. I've always wanted to find a good way to do this. +2 from me!

[rickard-von-essen]

@cbednarski I'll improve the docs and also need to test this on Windows and Linux. Linux should be no problem but Windows might require some fiddling and worst case do nothing for Windows.

Do you thing .PHONY is important? or can I change it when I'm done?

[cbednarski]

Do you thing .PHONY is important? or can I change it when I'm done?

.PHONY is a best practice but technically not required because there is no file/folder named help; feel free to change it later.

[tylert]

Nice!

Using .PHONY is recommended when the target is a "fake" one (i.e.: one for which no file named the same as the target is expected to be created).

[tylert]

NOTE: You can choose to either of the following in a makefile...

...
.PHONY: ultraclean
ultraclean:
    rm more stuff

.PHONY: clean
clean:
    rm stuff
...

or

...
ultraclean:
    rm more stuff

clean:
    rm stuff
...
.PHONY: clean ultraclean
...

It depends on whether you prefer keeping each PHONY right next to the target it references or putting them all together as has been done in this file.

[rickard-von-essen]

LGTM