docs/devel: Specify that GADGET_* macros are optional
#2498
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
blanquicet
force-pushed
the
jose/docs/gadget-macro-optional
branch
from
e210090
to
cb495dc
Compare
blanquicet
force-pushed
the
jose/docs/gadget-macro-optional
branch
2 times, most recently
from
a6f9feb
to
cf39159
Compare
Signed-off-by: Jose Blanquicet <josebl@microsoft.com>
blanquicet
force-pushed
the
jose/docs/gadget-macro-optional
branch
from
cf39159
to
51f5f53
Compare
This was referenced Mar 1, 2024
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.
docs/devel: Specify that
GADGET_*macros are optionalIt wasn't clear that the
GADGET_*macro is optional for the gadget to work. However, it's necessary to enable IG to generate (from scratch) the metadata file from the eBPF code.TODO (For a future PR)
Add a list with the type of gadgets we support:
tracerandsnapshotter(probably ingadget-helper-api.md) and refer it from the Implementing the eBPF program section ofhello-world-gadget.md.