docs: add overview for package features #1164
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
rgo3
force-pushed
the
docs-features
branch
2 times, most recently
from
987ddaa
to
349cbb9
Compare
ti-mo
reviewed
Oct 17, 2023
|
What should be included in the additional paragraphs per major type of probe vs what we have in the godocs? I am unsure what information a user would need per API and an example for each is a bit overkill IMO. |
Signed-off-by: Robin Gögge <r.goegge@isovalent.com>
This commit adds an overview page for the concept of feature detection in package `features`. It explains the differences of the provided API to `bpftool`, describes the returned error semantics and highlights a few of its limitations. Signed-off-by: Robin Gögge <r.goegge@isovalent.com> Co-authored-by: Timo Beckers <timo@isovalent.com>
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.
This PR adds an overview page for the concept of feature detection in package
features. It explains the differences of the provided API tobpftool, describes the returned error semantics and highlights a few of its shortcomings.