Skip to content

nvme: add ABI documentation for sysfs and configfs interfaces

Guixin Liu linux-nvme 4 versions – Applied

Status from this message: Thanks, applied to nvme-7.3.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest3 patches 3 repliesApplied
  2. v33 patches 10 repliesSuperseded
  3. v23 patches 4 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v13 patches7 repliesSuperseded

Changes in v4 from the cover letter

- Move the documentation from Documentation/ABI/testing/ to Documentation/ABI/stable/, since the NVMe host sysfs and target configfs interfaces are long-established, stable ABI (Daniel Wagner).
- Add Reviewed-by tag from Daniel Wagner in the first patch, and from Nilay Shroff in all three patches, thanks.

Patches in v4 Applied

#Subject and filesSizeRepliesApplied
1/3nvme: add ABI documentation for host sysfs interfacesDocumentation/ABI/stable/sysfs-nvme Documentation/ABI/testing/sysfs-nvme+453 -130 replies
2/3nvmet: add ABI documentation for target configfs interfacesDocumentation/ABI/stable/configfs-nvmet+352 -00 replies
3/3MAINTAINERS: add missing NVMe documentation filesMAINTAINERS+4 -00 replies

Reviews trailers per patch

All 3 patches have a Reviewed-by or Acked-by of their own; the series has one for all of them.

PatchHannes ReineckeDaniel WagnerNilay ShroffChristoph Hellwig
SeriesR-b R-b
1/3R-b R-b R-b
2/3R-b R-b
3/3R-b R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 4 reviewers.

Read the v4 thread

Cover letter [PATCH v4 0/3] nvme: add ABI documentation for sysfs and configfs interfaces

The NVMe host sysfs interfaces and target configfs interfaces lack ABI documentation under Documentation/ABI/. This series adds the missing documentation and updates MAINTAINERS accordingly.

Each attribute entry has been traced back to its original introducing commit via git archaeology to provide accurate Date, KernelVersion, and Contact information.

This documentation was created with the assistance of AI (Claude) for git history tracing and document formatting.

Patch 1 adds Documentation/ABI/stable/sysfs-nvme for host sysfs. Patch 2 adds Documentation/ABI/stable/configfs-nvmet for target configfs. Patch 3 adds missing F: entries in MAINTAINERS for NVMe documentation.

v3->v4:
- Move the documentation from Documentation/ABI/testing/ to Documentation/ABI/stable/, since the NVMe host sysfs and target configfs interfaces are long-established, stable ABI (Daniel Wagner).
- Add Reviewed-by tag from Daniel Wagner in the first patch, and from Nilay Shroff in all three patches, thanks.

v2->v3:
- sysfs: document the namespace diagnostic counters as two separate entries, one for non-multipath configurations (/sys/block/nvmeXnY/) and one for multipath configurations (/sys/block/nvmeXcYnZ/ per-path and /sys/block/nvmeXnY/ head), so the actual sysfs location of each counter is obvious without per-attribute visibility notes.
- sysfs: keep all diagnostic counters (controller and namespace) adjacent for easier browsing.
- sysfs: document the per-path attributes ana_grpid, ana_state, queue_depth and numa_nodes under /sys/block/nvmeXcYnZ/ to reflect their real location, dropping the now-redundant "only visible on per-path devices" wording.
- Add Reviewed-by tag from Hannes Reinecke in the first two patches, thanks.

v1->v2:
- sysfs: group all TLS attributes together and reorganize the file by device class (controller, namespace, subsystem), keeping related attributes grouped within each class; split the combined passthru_err_log_enabled entry into controller and namespace entries.
- configfs: group attributes by object type (ports, subsystems, hosts), merge dhchap_dhgroup into the DH-HMAC-CHAP host authentication entry, and split the combined ANA and PI-enable entries into separate port and subsystem entries.
- Add Reviewed-by tag from Hannes Reinecke in the third patch, thanks.

Guixin Liu (3):
nvme: add ABI documentation for host sysfs interfaces
nvmet: add ABI documentation for target configfs interfaces
MAINTAINERS: add missing NVMe documentation files

 Documentation/ABI/stable/configfs-nvmet | 352 ++++++++++++++++++
 Documentation/ABI/stable/sysfs-nvme     | 453 ++++++++++++++++++++++++
 Documentation/ABI/testing/sysfs-nvme    |  13 -
 MAINTAINERS                             |   4 +
 4 files changed, 809 insertions(+), 13 deletions(-)
 create mode 100644 Documentation/ABI/stable/configfs-nvmet
 create mode 100644 Documentation/ABI/stable/sysfs-nvme
 delete mode 100644 Documentation/ABI/testing/sysfs-nvme
Signature · 1 line
2.43.7