make help: show generate-Makefile.ci

[mguetschow]

Contribution description

generate-Makefile.ci is the only target interesting to the user containing uppercase and a dot, which wasn't matched by the sed command used in make help. Changing that accordingly matches *.module and *.xml targets, too, which still shouldn't be part of the user-visible targets. Therefore, those are filtered out with grep.

Testing procedure

1. on master: make -C examples/hello-world help > before
2. with this PR: make -C examples/hello-world help > after
3. diff before after results in:

46a47
> generate-Makefile.ci

Issues/PRs references

generate-Makefile.ci was added with #19244

[benpicco]

Please add a comment as to what this incantation is good for.

[mguetschow]

Added and force-pushed.

[kaspar030]

you could move the grep as additional -e expression to sed. not sure that makes it more readable or measurably faster.

Suggested change

	@$(MAKE) -qp | sed -ne 's/\(^[a-z][a-zA-Z._-]*\):.*/\1/p' | grep -Fv -e '.module' -e '.xml' | sort | uniq
	@$(MAKE) -qp | sed -e '/\.module$/d' -e '/\.xml$/d' -ne 's/\(^[a-z][a-zA-Z._-]*\):.*/\1/p' | sort | uniq

My sort has an -u flag that further allows removing uniq.

[riot-ci]

Murdock results

✔️ PASSED

292393c make help: show generate-Makefile.ci

Success	Failures	Total	Runtime
8082	0	8082	10m:47s

Artifacts

• Documentation preview

[mguetschow]

Further thinking about it after @kaspar030's comment lead me to reconsider my choice of blacklisting specifically *.module and *.xml, I could imagine there to be more non-user targets for different configurations/applications. Maybe a whitelisting approach to include generate-Makefile.ci explicitely is a better idea?

Something like sed -ne 's/\(^[a-z][a-z_-]*\|generate-Makefile.ci\):.*/\1/p'

[benpicco]

Ideally we would have a map: target - description

The target names alone are of little help unless you already know what they are doing.

[mguetschow]

Maybe a whitelisting approach to include generate-Makefile.ci explicitely is a better idea?

That's what I've changed it to now. Still feels a bit hacky, but probably cleaner than the former solution.

Ideally we would have a map: target - description

Very true, I second this! But until that is added, this PR still is an improvement over the current situation.

The target names alone are of little help unless you already know what they are doing.

In this case I remembered there was a Makefile command for generating the Makefile.ci, but couldn't find it in the list.