libbpf: add Doxygen docs for public LIBBPF_API APIs #6263
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 5 commits
October 30, 2025 20:34
Add doxygen comment blocks for all public bpf_map_* APIs in tools/lib/bpf/bpf.h. These doc comments are for: -bpf_map_create() -bpf_map_update_elem() -bpf_map_lookup_elem() -bpf_map_lookup_elem_flags() -bpf_map_lookup_and_delete_elem() -bpf_map_lookup_and_delete_elem_flags() -bpf_map_delete_elem() -bpf_map_delete_elem_flags() -bpf_map_get_next_key() -bpf_map_freeze() -bpf_map_get_next_id() -bpf_map_get_fd_by_id() -bpf_map_get_fd_by_id_opts() Signed-off-by: Jianyun Gao <[email protected]>
Add doxygen comment blocks for all public bpf_prog_* APIs in tools/lib/bpf/bpf.h. These doc comments are for: -bpf_prog_load() -bpf_prog_attach() -bpf_prog_detach() -bpf_prog_detach2() -bpf_prog_get_next_id() -bpf_prog_get_fd_by_id() -bpf_prog_get_fd_by_id_opts() -bpf_prog_query() -bpf_prog_bind_map() -bpf_prog_test_run_opts() Signed-off-by: Jianyun Gao <[email protected]>
Add doxygen comment blocks for all public bpf_link_* APIs in tools/lib/bpf/bpf.h. These doc comments are for: -bpf_link_create() -bpf_link_detach() -bpf_link_update() -bpf_link_get_next_id() -bpf_link_get_fd_by_id() -bpf_link_get_fd_by_id_opts() Signed-off-by: Jianyun Gao <[email protected]>
Add doxygen comment blocks for all public bpf_obj_* APIs in tools/lib/bpf/bpf.h. These doc comments are for: -bpf_obj_pin() -bpf_obj_pin_opts() -bpf_obj_get() -bpf_obj_get_opts() -bpf_obj_get_info_by_fd() Signed-off-by: Jianyun Gao <[email protected]>
Add doxygen comment blocks for emaining helpers (btf/iter etc.) in tools/lib/bpf/bpf.h. These doc comments are for: -libbpf_set_memlock_rlim() -bpf_btf_load() -bpf_iter_create() -bpf_btf_get_next_id() -bpf_btf_get_fd_by_id() -bpf_btf_get_fd_by_id_opts() -bpf_raw_tracepoint_open_opts() -bpf_raw_tracepoint_open() -bpf_task_fd_query() Signed-off-by: Jianyun Gao <[email protected]>
Author
|
Upstream branch: 5701d5a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request for series with
subject: libbpf: add Doxygen docs for public LIBBPF_API APIs
version: 1
url: https://patchwork.kernel.org/project/netdevbpf/list/?series=1017992