doc: fix sysfs ABI documentation
authorStephen Hemminger <stephen@networkplumber.org>
Sat, 12 May 2018 08:45:29 +0000 (01:45 -0700)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 14 May 2018 14:06:48 +0000 (16:06 +0200)
In 4.9 kernel, the sysfs files for Hyper-V VMBus changed name but
the documentation files were not updated. The current sysfs file
names are /sys/bus/vmbus/devices/<UUID>/...

See commit 9a56e5d6a0ba ("Drivers: hv: make VMBus bus ids persistent")
and commit f6b2db084b65 ("vmbus: make sysfs names consistent with PCI")

Reported-by: Michael Kelley <mikelley@microsoft.com>
Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
Cc: stable@vger.kernel.org
Signed-off-by: K. Y. Srinivasan <kys@microsoft.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/stable/sysfs-bus-vmbus

index 0c9d9dc..3eaffbb 100644 (file)
@@ -1,25 +1,25 @@
-What:          /sys/bus/vmbus/devices/vmbus_*/id
+What:          /sys/bus/vmbus/devices/<UUID>/id
 Date:          Jul 2009
 KernelVersion: 2.6.31
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The VMBus child_relid of the device's primary channel
 Users:         tools/hv/lsvmbus
 
 Date:          Jul 2009
 KernelVersion: 2.6.31
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The VMBus child_relid of the device's primary channel
 Users:         tools/hv/lsvmbus
 
-What:          /sys/bus/vmbus/devices/vmbus_*/class_id
+What:          /sys/bus/vmbus/devices/<UUID>/class_id
 Date:          Jul 2009
 KernelVersion: 2.6.31
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The VMBus interface type GUID of the device
 Users:         tools/hv/lsvmbus
 
 Date:          Jul 2009
 KernelVersion: 2.6.31
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The VMBus interface type GUID of the device
 Users:         tools/hv/lsvmbus
 
-What:          /sys/bus/vmbus/devices/vmbus_*/device_id
+What:          /sys/bus/vmbus/devices/<UUID>/device_id
 Date:          Jul 2009
 KernelVersion: 2.6.31
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The VMBus interface instance GUID of the device
 Users:         tools/hv/lsvmbus
 
 Date:          Jul 2009
 KernelVersion: 2.6.31
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The VMBus interface instance GUID of the device
 Users:         tools/hv/lsvmbus
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channel_vp_mapping
+What:          /sys/bus/vmbus/devices/<UUID>/channel_vp_mapping
 Date:          Jul 2015
 KernelVersion: 4.2.0
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Date:          Jul 2015
 KernelVersion: 4.2.0
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
@@ -28,112 +28,112 @@ Description:      The mapping of which primary/sub channels are bound to which
                Format: <channel's child_relid:the bound cpu's number>
 Users:         tools/hv/lsvmbus
 
                Format: <channel's child_relid:the bound cpu's number>
 Users:         tools/hv/lsvmbus
 
-What:          /sys/bus/vmbus/devices/vmbus_*/device
+What:          /sys/bus/vmbus/devices/<UUID>/device
 Date:          Dec. 2015
 KernelVersion: 4.5
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The 16 bit device ID of the device
 Users:         tools/hv/lsvmbus and user level RDMA libraries
 
 Date:          Dec. 2015
 KernelVersion: 4.5
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The 16 bit device ID of the device
 Users:         tools/hv/lsvmbus and user level RDMA libraries
 
-What:          /sys/bus/vmbus/devices/vmbus_*/vendor
+What:          /sys/bus/vmbus/devices/<UUID>/vendor
 Date:          Dec. 2015
 KernelVersion: 4.5
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The 16 bit vendor ID of the device
 Users:         tools/hv/lsvmbus and user level RDMA libraries
 
 Date:          Dec. 2015
 KernelVersion: 4.5
 Contact:       K. Y. Srinivasan <kys@microsoft.com>
 Description:   The 16 bit vendor ID of the device
 Users:         tools/hv/lsvmbus and user level RDMA libraries
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Directory for per-channel information
                NN is the VMBUS relid associtated with the channel.
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Directory for per-channel information
                NN is the VMBUS relid associtated with the channel.
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/cpu
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/cpu
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   VCPU (sub)channel is affinitized to
 Users:         tools/hv/lsvmbus and other debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   VCPU (sub)channel is affinitized to
 Users:         tools/hv/lsvmbus and other debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/cpu
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/cpu
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   VCPU (sub)channel is affinitized to
 Users:         tools/hv/lsvmbus and other debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   VCPU (sub)channel is affinitized to
 Users:         tools/hv/lsvmbus and other debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/in_mask
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/in_mask
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Host to guest channel interrupt mask
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Host to guest channel interrupt mask
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/latency
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/latency
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Channel signaling latency
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Channel signaling latency
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/out_mask
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/out_mask
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Guest to host channel interrupt mask
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Guest to host channel interrupt mask
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/pending
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/pending
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Channel interrupt pending state
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Channel interrupt pending state
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/read_avail
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/read_avail
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Bytes available to read
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Bytes available to read
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/write_avail
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/write_avail
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Bytes available to write
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Bytes available to write
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/events
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/events
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Number of times we have signaled the host
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Number of times we have signaled the host
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/interrupts
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/interrupts
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Number of times we have taken an interrupt (incoming)
 Users:         Debugging tools
 
 Date:          September. 2017
 KernelVersion: 4.14
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Number of times we have taken an interrupt (incoming)
 Users:         Debugging tools
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/subchannel_id
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/subchannel_id
 Date:          January. 2018
 KernelVersion: 4.16
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Subchannel ID associated with VMBUS channel
 Users:         Debugging tools and userspace drivers
 
 Date:          January. 2018
 KernelVersion: 4.16
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Subchannel ID associated with VMBUS channel
 Users:         Debugging tools and userspace drivers
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/monitor_id
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/monitor_id
 Date:          January. 2018
 KernelVersion: 4.16
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Monitor bit associated with channel
 Users:         Debugging tools and userspace drivers
 
 Date:          January. 2018
 KernelVersion: 4.16
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Description:   Monitor bit associated with channel
 Users:         Debugging tools and userspace drivers
 
-What:          /sys/bus/vmbus/devices/vmbus_*/channels/NN/ring
+What:          /sys/bus/vmbus/devices/<UUID>/channels/<N>/ring
 Date:          January. 2018
 KernelVersion: 4.16
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>
 Date:          January. 2018
 KernelVersion: 4.16
 Contact:       Stephen Hemminger <sthemmin@microsoft.com>