doc: add function-index with suggested renames toward nvme_verb_noun convention#11
Closed
doc: add function-index with suggested renames toward nvme_verb_noun convention#11
Conversation
Co-authored-by: igaw <1050803+igaw@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add table of function names from NVMe headers
doc: add libnvme API function index table
Mar 16, 2026
Co-authored-by: igaw <1050803+igaw@users.noreply.github.com>
Copilot
AI
changed the title
doc: add libnvme API function index table
doc: add libnvme API function index with rename suggestions
Mar 16, 2026
Co-authored-by: igaw <1050803+igaw@users.noreply.github.com>
Copilot
AI
changed the title
doc: add libnvme API function index with rename suggestions
doc: add function-index with suggested renames toward nvme_verb_noun convention
Mar 16, 2026
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
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.
libnvme's public API uses an inconsistent naming scheme — some functions are
nvme_get_host, others arenvme_host_get. This adds a reference table mapping every public function to its suggested rename following the uniformnvme_<verb>_<noun>pattern.Changes
libnvme/doc/function-index.md— two-column table (Function|Suggested Name) covering all 233 public functions across 9 headers (tree.h,mi.h,linux.h,lib.h,ioctl.h,filters.h,fabrics.h,nbft.h,util.h)—(102 entries); the rest carry an explicit suggestion (131 entries)Renaming rules applied
nvme_host_getnvme_get_hostnvme_ctrl_get_statenvme_get_ctrl_statenvme_ctrl_for_each_nsnvme_for_each_ctrl_nsnvme_ns_head_get_sysfs_dirnvme_get_ns_head_sysfs_dirnvme_transport_handle_get_fdnvme_get_transport_handle_fdnvme_mi_aem_aesi_get_aesenvme_mi_get_aem_aesi_aesenvme_mi_mi_config_getnvme_mi_mi_get_confignvme_hostnqn_generatenvme_generate_hostnqn🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.