docs: add comments to the example Makefile #156
Merged
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
Added comments through a new `help` target because that way anyone can use `make help` in the `examples/make` directory and get the full list of targets and a description. Closes #110 References: * #110 * https://www.thapaliya.com/en/writings/well-documented-makefiles/
mandelsoft
approved these changes
Oct 20, 2022
There was a problem hiding this comment.
I've noticed that this Makefile is quite old and simple,
there are more elaborated ones below the components folder for the TOI scenario example,
may be we could add references to these examples, also (at the place where this makefile is referenced).
These one support command line overrides for repository, multi-arch image builds, etc.
mandelsoft
requested changes
Oct 20, 2022
examples/make/Makefile
Outdated
|
|
||
| REPO_ROOT := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) | ||
| VERSION = $(shell cat $(REPO_ROOT)/VERSION) | ||
| COMMIT = $(shell git rev-parse HEAD) | ||
| EFFECTIVE_VERSION = $(VERSION)-$(COMMIT) | ||
|
|
||
| .PHONY: ctf | ||
| ctf: ca | ||
| ctf: ca ## Create CTF from componet archive |
mandelsoft
approved these changes
Oct 21, 2022
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.
Added comments through a new
helptarget because that way anyone can usemake helpin theexamples/makedirectory and get the full list of targets and a description.Closes #110
References:
Makefileexample #110