Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix assertions about tracingpolicy args field #2062

Conversation

h3x-eilidh
Copy link
Contributor

The docs about the tracing policies args field make wrong assertions about its use.
The args field is not mandatory and it is currently not supported on uprobes.

The args field is not mandatory neither in kprobes nor in tracepoints and it is not supported on uprobes.

Signed-off-by: Luigi De Matteis <eilidh3773@gmail.com>
Make the introduction to the args purposes that are (explained later in the docs with examples) more accurate and less misleading.

Signed-off-by: Luigi De Matteis <eilidh3773@gmail.com>
@h3x-eilidh h3x-eilidh requested review from mtardy and a team as code owners February 5, 2024 05:41
Copy link

netlify bot commented Feb 5, 2024

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit 960cbb0
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/65c074ff807a8b00078dbd8d
😎 Deploy Preview https://deploy-preview-2062--tetragon.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey! Thanks a lot for reading and fixing the docs, you are correct for v1.0 it was indeed a mistake but this one was fixed very recently, so it's now technically correct if you want to try the latest build, see #1978.

@h3x-eilidh
Copy link
Contributor Author

Nice! I didn't know about it, thank you @mtardy.
I'll close the PR

@h3x-eilidh h3x-eilidh closed this Feb 6, 2024
@h3x-eilidh h3x-eilidh deleted the pr/h3x-eilidh/fix-tracingpolicy-args-docs branch February 6, 2024 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants