Add introduction to eBPF #76
Conversation
I think it's fine to have these examples here - they're being used to illustrate a point, not to provide a sequence of instructions :) I'd say leave them as they are, no need to remove. |
athos-ribeiro
force-pushed
the
bpf-doc
branch
from
d0e0ab3 to
ca374dd
Compare
|
Thanks for the review, @s-makin I addressed most of your points and commented on the ones I could not address :) |
athos-ribeiro
force-pushed
the
bpf-doc
branch
from
ca374dd to
c3a7e70
Compare
explanation/intro-to/ebpf.md
Outdated
| After the verification step, the bytecode is Just-In-Time (JIT) compiled into | ||
| machine-code to optimize the program's execution. | ||
|
|
||
| eBPF is a powerful tool for server and system administrators. It provides the |
There was a problem hiding this comment.
The new title is good and suits the rest of the content, but I'd still prefer this first paragraph to be near the top (in the intro). It basically provides all the justification (the "why should I care?") that the reader is looking for to know whether it's relevant or interesting for them. Imo, once a reader is halfway down the page, they've already decided they're interested (and the "why" is a waste of their time at that point). If they don't get halfway down because we didn't provide a strong hook then they'll never see that this is relevant for them. This paragraph does a great job of explaining the "why", so I'd rather not bury it, but rather put it right in front of the reader's eyes :)
athos-ribeiro
force-pushed
the
bpf-doc
branch
from
c3a7e70 to
fa50c06
Compare
|
Hi Sally! I addressed most of your comments again and replied your questions. Let me know how it looks now :) |
Signed-off-by: Athos Ribeiro <[email protected]>
athos-ribeiro
force-pushed
the
bpf-doc
branch
from
fa50c06 to
846c669
Compare
|
Thanks, Christian! I applied all your changes and pushed them here |
There was a problem hiding this comment.
Final check:
- The "why one should care" is now at the start - was a request of @s-makin
- The same section got my suggested extensions which makes it even more "you want to care"
- The extended examples and their evolution into self-modifying has landed
- The extended references have landed
- All other smaller changes requested have been landed
So all content is good,
we have two language questions left open and my new content needs the eyes of @s-makin for style and words.
I've pinged trying to land this rather soon.
|
I've prepared a small fixup which is ready to land together with all of this here. |
Sally and I had an interactive session closing out the few open questions and phrasing of PR #76. Combined with all the feedback Athos already integrated to the current state of his branch we can merge it now. Changes: - update structure of the intro - rebalance headers - guard arguments and file paths with backticks - regroup the "modify to your needs" section - several "ensure readability" rewrite of sentences - capitalize QEMU and OpenStack correctly - make all mention of bpf, BPF, ... -> eBPF Signed-off-by: Christian Ehrhardt <[email protected]>
|
FYI 6af3763 is the follow up that landed as well. |
This is a short introduction to eBPF, (hopefully) in a Ubuntu server user context. I was not sure whether I should expand on the examples and move them to a different section (e.g., How to) or if I should simply omit them and save them for a how-to guide in the future. Still, I kept them short and they are what they are supposed to be, just examples :)