-
Notifications
You must be signed in to change notification settings - Fork 59
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
Update development.md #156
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for aya-rs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
docs/book/start/development.md
Outdated
@@ -35,7 +35,7 @@ cargo install cargo-generate | |||
``` | |||
|
|||
And finally to generate bindings for kernel data structures, you must install | |||
`bpftool`, either from your distribution or building it from | |||
`bpftool`. This tool is part of the package `linux-tools-common`, `linux-lowlatency-tools-common` or you can build it from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These names are unlikely to be the same across distros? Also IIRC linux-tools-common under ubuntu installs a stub that when executed tells you "you need to install linux-tools-" or something like that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right but it was not clear for me,btw I rewrite it
docs/book/start/development.md
Outdated
And finally to generate bindings for kernel data structures, you must install | ||
`bpftool`, either from your distribution or building it from | ||
[source](https://github.com/libbpf/bpftool). | ||
To generate bindings for kernel data structures, you'll need to install bpftool. You can locate this tool as part of a larger tools package in certain distributions (e.g., `linux-tools-common` on Ubuntu), or you can opt to build it from its [source](https://github.com/libbpf/bpftool). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say
To generate bindings for kernel types you need to install bpftool. You can install it from your
distribution (run `sudo apt install linux-tools-$(uname -r)` under debian based distributions), or
building from [source])(https://github.com/libbpf/bpftool).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes! It's perfect!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we'd rather not encode another project's installation instructions. We can link to their docs, but I don't want to repeat non-canonical details.
+1 to what Tamir said. Bear in mind on Fedora |
No problem! It was the only unclear step for me, but most likely the problem is me 😂 |
No description provided.