Linux-NVME Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Guixin Liu <kanie@linux.alibaba.com>
To: Christoph Hellwig <hch@lst.de>, Sagi Grimberg <sagi@grimberg.me>,
	Chaitanya Kulkarni <kch@nvidia.com>,
	Hannes Reinecke <hare@suse.com>, Daniel Wagner <dwagner@suse.de>,
	Shin'ichiro Kawasaki <shinichiro.kawasaki@wdc.com>,
	John Garry <john.g.garry@oracle.com>,
	Nilay Shroff <nilay@linux.ibm.com>
Cc: linux-nvme@lists.infradead.org, xlpang@linux.alibaba.com,
	oliver.yang@linux.alibaba.com
Subject: [PATCH v4 0/3] nvme: add ABI documentation for sysfs and configfs interfaces
Date: Tue,  7 Jul 2026 20:12:24 +0800	[thread overview]
Message-ID: <20260707121227.2274769-1-kanie@linux.alibaba.com> (raw)

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

-- 
2.43.7



             reply	other threads:[~2026-07-07 12:12 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-07 12:12 Guixin Liu [this message]
2026-07-07 12:12 ` [PATCH v4 1/3] nvme: add ABI documentation for host sysfs interfaces Guixin Liu
2026-07-07 12:12 ` [PATCH v4 2/3] nvmet: add ABI documentation for target configfs interfaces Guixin Liu
2026-07-07 12:12 ` [PATCH v4 3/3] MAINTAINERS: add missing NVMe documentation files Guixin Liu
2026-07-09  5:56 ` [PATCH v4 0/3] nvme: add ABI documentation for sysfs and configfs interfaces Christoph Hellwig
2026-07-09 13:12 ` Daniel Wagner
2026-07-09 17:12 ` Keith Busch

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260707121227.2274769-1-kanie@linux.alibaba.com \
    --to=kanie@linux.alibaba.com \
    --cc=dwagner@suse.de \
    --cc=hare@suse.com \
    --cc=hch@lst.de \
    --cc=john.g.garry@oracle.com \
    --cc=kch@nvidia.com \
    --cc=linux-nvme@lists.infradead.org \
    --cc=nilay@linux.ibm.com \
    --cc=oliver.yang@linux.alibaba.com \
    --cc=sagi@grimberg.me \
    --cc=shinichiro.kawasaki@wdc.com \
    --cc=xlpang@linux.alibaba.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox