github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-13 15:40:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

cxl/Documentation: Spell out globbed sysfs attribute names

Browse Source 
Four entries in sysfs-bus-cxl use braced globs to document groups of
attributes. Where the glob factors out a common prefix, as in
cap_{pmem,ram,type2,type3}, no individual attribute name appears in
the file at all and none can be found by grep or get_abi.py search. In
every case the glob also keys get_abi.py validate on the glob string,
so duplicates against separately documented attributes go undetected.

Replace the globs with consecutive What: lines for each attribute.
These lines continue to share the existing metadata and description
and follow the format used in sysfs-driver-ufs and sysfs-bus-iio.

Also restore one missing blank line between entries.

Verify with:
  python3 tools/docs/get_abi.py -D Documentation/ABI/testing validate
  python3 tools/docs/get_abi.py search cap_pmem
  python3 tools/docs/get_abi.py search create_ram_region

validate reports no sysfs-bus-cxl warning, and both searches now return
the stanza where they returned nothing before.

Signed-off-by: Alison Schofield <alison.schofield@intel.com>
Reviewed-by: Dave Jiang <dave.jiang@intel.com>
Link: https://patch.msgid.link/20260804232014.2286549-1-alison.schofield@intel.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
This commit is contained in:
Alison Schofield 2026-08-04 16:20:08 -07:00 committed by Dave Jiang
parent 94d84e3d89
commit d7066cfc41
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/ABI/testing/sysfs-bus-cxl
View File

@ -201,7 +201,8 @@ Description:
capability.
What: /sys/bus/cxl/devices/{port,endpoint}X/parent_dport
What: /sys/bus/cxl/devices/portX/parent_dport
What: /sys/bus/cxl/devices/endpointX/parent_dport
Date: January, 2023
KernelVersion: v6.3
Contact: linux-cxl@vger.kernel.org
@ -258,7 +259,8 @@ Description:
instance id of a given decoder resource.
What: /sys/bus/cxl/devices/decoderX.Y/{start,size}
What: /sys/bus/cxl/devices/decoderX.Y/start
What: /sys/bus/cxl/devices/decoderX.Y/size
Date: June, 2021
KernelVersion: v5.14
Contact: linux-cxl@vger.kernel.org
@ -297,7 +299,10 @@ Description:
Each entry in the list is a dport id.
What: /sys/bus/cxl/devices/decoderX.Y/cap_{pmem,ram,type2,type3}
What: /sys/bus/cxl/devices/decoderX.Y/cap_pmem
What: /sys/bus/cxl/devices/decoderX.Y/cap_ram
What: /sys/bus/cxl/devices/decoderX.Y/cap_type2
What: /sys/bus/cxl/devices/decoderX.Y/cap_type3
Date: June, 2021
KernelVersion: v5.14
Contact: linux-cxl@vger.kernel.org
@ -410,7 +415,8 @@ Description:
interleave_granularity).
What: /sys/bus/cxl/devices/decoderX.Y/create_{pmem,ram}_region
What: /sys/bus/cxl/devices/decoderX.Y/create_pmem_region
What: /sys/bus/cxl/devices/decoderX.Y/create_ram_region
Date: May, 2022, January, 2023
KernelVersion: v6.0 (pmem), v6.3 (ram)
Contact: linux-cxl@vger.kernel.org
@ -500,6 +506,7 @@ Description:
cache is present, the size indicates extended linear cache size
plus the CXL region size.
What: /sys/bus/cxl/devices/regionZ/extended_linear_cache_size
Date: October, 2025
KernelVersion: v6.19