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

doc: update eBPF/compilation instructions v3 #10614

Closed

Conversation

lukashino
Copy link
Contributor

Follow-up of #10560

Link to Redmine tickets:

Describe changes:
v3

  • updates to the docs per Jeff's suggestions
  • removed the instruction to install i386 headers for the eBPF

v2

  • remove recommended configure parameters

v1

  • small edit in eBPF instructions to prefer libbpf-dev package to the cloning&compilation
  • porting changes from the improved version of installation instructions that got merged into master-6.0.x

@lukashino lukashino requested a review from jufajardini as a code owner March 11, 2024 14:55
@lukashino lukashino added the typo/doc update No code change : only doc or typo fixes label Mar 13, 2024
Copy link
Contributor

@jufajardini jufajardini left a comment

Choose a reason for hiding this comment

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

Two minor-ish inline comments for the docs :P
Looking mostly ready, imho.

Comment on lines +159 to +165
1) Install Rust https://www.rust-lang.org/en-US/install.html
2) Install cbindgen - if the cbindgen is not found in the repository
or the cbindgen version is lower than required, it can be
alternatively installed as: cargo install --force cbindgen
3) Make sure the cargo path is within your PATH environment
e.g. echo 'export PATH=”${PATH}:~/.cargo/bin”' >> ~/.bashrc
e.g. export PATH="${PATH}:~/.cargo/bin"
Copy link
Contributor

Choose a reason for hiding this comment

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

As we mostly try to keep command-line instructions in a separate line, I think here we could at least highlight them as inline code (as that's probably easier to achieve inside a list than have it in a separate line :P )

Copy link
Contributor Author

@lukashino lukashino Apr 9, 2024

Choose a reason for hiding this comment

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

That is not possible because this list is already in the code block.
I've therefore at least made it shorter:
echo 'export PATH+=”~/.cargo/bin”' >> ~/.bashrc' && export PATH+=”~/.cargo/bin”

@lukashino
Copy link
Contributor Author

Follow up in #10788

@lukashino lukashino closed this Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo/doc update No code change : only doc or typo fixes
Development

Successfully merging this pull request may close these issues.

2 participants