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

helper-function: fix formatting of bpf_probe_read_user_str.md #75

Merged
merged 5 commits into from
Oct 28, 2024

Conversation

kxxt
Copy link
Contributor

@kxxt kxxt commented Oct 23, 2024

Fix formatting of the code block and some inline codes.

image

Copy link
Collaborator

@dylandreimerink dylandreimerink left a comment

Choose a reason for hiding this comment

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

Thank you for fixing this!

This bit of the docs is actually auto generated from the libbpf headers (see <!-- [HELPER_FUNC_DEF] --> and <!-- [/HELPER_FUNC_DEF] --> markers).

I suggest we remove these markers, so this will not be reverted next time we run the make generate-docs command and take ownership of the definition ourselfs.

Fix formatting of the code block and some inline codes.
@kxxt
Copy link
Contributor Author

kxxt commented Oct 25, 2024

Thank you for fixing this!

This bit of the docs is actually auto generated from the libbpf headers (see <!-- [HELPER_FUNC_DEF] --> and <!-- [/HELPER_FUNC_DEF] --> markers).

I suggest we remove these markers, so this will not be reverted next time we run the make generate-docs command and take ownership of the definition ourselfs.

Thanks for your review! I have removed HELPER_FUNC_DEF marker from the doc.

Copy link
Collaborator

@dylandreimerink dylandreimerink left a comment

Choose a reason for hiding this comment

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

Awesome! Thanks for the fix.

It seems that brought the wrath of CI, after fixing that we should be good.

docs/linux/helper-function/bpf_probe_read_user_str.md Outdated Show resolved Hide resolved
docs/linux/helper-function/bpf_probe_read_user_str.md Outdated Show resolved Hide resolved
docs/linux/helper-function/bpf_probe_read_user_str.md Outdated Show resolved Hide resolved
docs/linux/helper-function/bpf_probe_read_user_str.md Outdated Show resolved Hide resolved
@dylandreimerink dylandreimerink merged commit 82844e8 into isovalent:master Oct 28, 2024
1 check passed
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