Skip to content

doc: update and polish README.md#3242

Merged
igaw merged 1 commit intolinux-nvme:masterfrom
martin-belanger:readme-updates
Apr 7, 2026
Merged

doc: update and polish README.md#3242
igaw merged 1 commit intolinux-nvme:masterfrom
martin-belanger:readme-updates

Conversation

@martin-belanger
Copy link
Copy Markdown

While updating symbol names to follow the nvme_libnvme_ API rename introduced in eb67416, I noticed a number of other inconsistencies and took the opportunity to clean them up as well.

Changes include:

  • Update struct and symbol names throughout to use the libnvme_ prefix
  • Fix a typo in the plugin example (foo quzfoo qux)
  • Correct CI container label ("Ubuntu" → "Debian")
  • Remove stale references to nvme-cli 1.x/2.x in the Dependency section
  • Fix section title: "Persistent, volatile" → "Persistent and volatile"
  • Convert all tab-indented code blocks to fenced code blocks
  • Promote Distro Support subsections from h4 to h3
  • Format bare URLs as proper markdown links

Update symbol names following the nvme_ to libnvme_ rename,
fix several typos, remove stale version references, and improve
formatting consistency throughout.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
@igaw igaw merged commit 28284c1 into linux-nvme:master Apr 7, 2026
29 checks passed
@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Apr 7, 2026

Thanks!

@martin-belanger martin-belanger deleted the readme-updates branch April 7, 2026 16:42
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