Skip to content

doc: add function-index with suggested renames toward nvme_verb_noun convention#11

Closed
Copilot wants to merge 4 commits intomasterfrom
copilot/create-function-table-review
Closed

doc: add function-index with suggested renames toward nvme_verb_noun convention#11
Copilot wants to merge 4 commits intomasterfrom
copilot/create-function-table-review

Conversation

Copy link

Copilot AI commented Mar 16, 2026

libnvme's public API uses an inconsistent naming scheme — some functions are nvme_get_host, others are nvme_host_get. This adds a reference table mapping every public function to its suggested rename following the uniform nvme_<verb>_<noun> pattern.

Changes

  • New file 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)
  • Functions already following the convention show (102 entries); the rest carry an explicit suggestion (131 entries)

Renaming rules applied

Current pattern Suggested pattern
nvme_host_get nvme_get_host
nvme_ctrl_get_state nvme_get_ctrl_state
nvme_ctrl_for_each_ns nvme_for_each_ctrl_ns
nvme_ns_head_get_sysfs_dir nvme_get_ns_head_sysfs_dir
nvme_transport_handle_get_fd nvme_get_transport_handle_fd
nvme_mi_aem_aesi_get_aese nvme_mi_get_aem_aesi_aese
nvme_mi_mi_config_get nvme_mi_mi_get_config
nvme_hostnqn_generate nvme_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.

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
Copilot AI requested a review from igaw March 16, 2026 09:13
Copilot finished work on behalf of igaw March 16, 2026 09:13
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
Copilot finished work on behalf of igaw March 16, 2026 09:32
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
Copilot finished work on behalf of igaw March 16, 2026 09:36
@igaw igaw closed this Mar 16, 2026
@igaw igaw deleted the copilot/create-function-table-review branch March 16, 2026 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants