Fix makefile help #371
Merged
Fix makefile help #371
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Commit [1] that originally introduced make help target also had special comments (starting with ###) for help target to parse. Makefile that was finally merged after some changes lacked this comments. Without this comments when executed help prints empty output. PR: alicebob#371 [1]: alicebob@72133e9 Signed-off-by: Wojciech Szarański <[email protected]>
It's clearer to keep target and it's .PHONY together. When reading Makefile it's easier to see if target is phony or not (without jumping back to first line and reading all of .PHONY dependencies). It's also harder to forget remove/rename .PHONY dependency when target is changed when they are together. There is no official standard but make documentation[1] in .DEFAULT_GOAL use multiple .PHONY: > .PHONY: foo > foo: ; @echo $@ > > $(warning default goal is $(.DEFAULT_GOAL)) > > # Reset the default goal. > .DEFAULT_GOAL := > > .PHONY: bar > bar: ; @echo $@ PR: alicebob#371 [1]: https://www.gnu.org/software/make/manual/html_node/Special-Variables.html Signed-off-by: Wojciech Szarański <[email protected]>
wszaranski
force-pushed
the
fix-makefile-help
branch
from
c500edb
to
5eca1e3
Compare
|
Oh, the |
alicebob
pushed a commit
that referenced
this pull request
Apr 9, 2024
Commit [1] that originally introduced make help target also had special comments (starting with ###) for help target to parse. Makefile that was finally merged after some changes lacked this comments. Without this comments when executed help prints empty output. PR: #371 [1]: 72133e9 Signed-off-by: Wojciech Szarański <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Makefile help comments
Commit that originally introduced make help target also had special comments (starting with
###) for help target to parse.Makefile that was finally merged after some changes lacked this comments. Without this comments when executed help prints empty output.
Move .PHONY next to each target
It's clearer to keep target and it's .PHONY together. When reading Makefile it's easier to see if target is phony or not (without jumping back to first line and reading all of .PHONY dependencies). It's also harder to forget remove/rename .PHONY dependency when target is changed when they are together.
There is no official standard but make documentation in .DEFAULT_GOAL use multiple .PHONY: