From 95776dc6ec174f47fa4dd4d8abf5d457223e5dd4 Mon Sep 17 00:00:00 2001
From: Kay Sievers <kay.sievers@suse.de>
Date: Sat, 19 Aug 2006 16:06:25 +0200
Subject: consistent key naming to match only the event device or include all
 parent devices

This scheme is more consistent and makes it obvious if a match happens
against the event device only, or the full chain of parent devices.

The old key names are now:
  BUS -> SUBSYSTEMS
  ID -> KERNELS
  SYSFS -> ATTRS
  DRIVER -> DRIVERS

Match keys for the event device:
  KERNEL
  SUBSYSTEM
  ATTR
  DRIVER (in a future release, for now the same as DRIVERS)

Match keys for all devices along the parent device chain:
  KERNELS
  SUBSYSTEMS
  ATTRS
  DRIVERS

ID, BUS, SYSFS are no longer mentioned in the man page but still work.
DRIVER must be converted to DRIVERS to match the new scheme. For now,
an error is logged, if DRIVER is used. In a future release, the DRIVER
key behaviour will change.
---
 udev.7 | 39 ++++++++++++++++++++++-----------------
 1 file changed, 22 insertions(+), 17 deletions(-)

(limited to 'udev.7')

diff --git a/udev.7 b/udev.7
index cef84de041..e6828ee4ee 100644
--- a/udev.7
+++ b/udev.7
@@ -76,27 +76,32 @@ The following key names can be used to match against device properties:
 \fBACTION\fR
 Match the name of the event action.
 .TP 3n
-\fBKERNEL\fR
-Match the name of the device.
-.TP 3n
 \fBDEVPATH\fR
-Match the devpath of the device.
+Match the devpath of the event device.
+.TP 3n
+\fBKERNEL\fR
+Match the name of the event device.
 .TP 3n
 \fBSUBSYSTEM\fR
-Match the subsystem of the device.
+Match the subsystem of the event device.
+.TP 3n
+\fBATTR{\fR\fB\fIfilename\fR\fR\fB}\fR
+Match sysfs attribute values of the event device. Up to five
+\fBATTR\fR
+keys can be specified per rule. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
 .TP 3n
-\fBBUS\fR
+\fBKERNELS\fR
+Search the devpath upwards for a matching device name.
+.TP 3n
+\fBSUBSYSTEMS\fR
 Search the devpath upwards for a matching device subsystem name.
 .TP 3n
-\fBDRIVER\fR
+\fBDRIVERS\fR
 Search the devpath upwards for a matching device driver name.
 .TP 3n
-\fBID\fR
-Search the devpath upwards for a matching device name.
-.TP 3n
-\fBSYSFS{\fR\fB\fIfilename\fR\fR\fB}\fR
+\fBATTRS{\fR\fB\fIfilename\fR\fR\fB}\fR
 Search the devpath upwards for a device with matching sysfs attribute values. Up to five
-\fBSYSFS\fR
+\fBATTRS\fR
 keys can be specified per rule. All attributes must match on the same device. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
 .TP 3n
 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
@@ -187,13 +192,13 @@ The devpath of the device.
 .TP 3n
 \fB$id\fR, \fB%b\fR
 The name of the device matched while searching the devpath upwards for
-\fBBUS\fR,
-\fBID\fR
-\fBDRIVER\fR
+\fBSUBSYSTEMS\fR,
+\fBKERNELS\fR
+\fBDRIVERS\fR
 and
-\fBSYSFS\fR.
+\fBATTRS\fR.
 .TP 3n
-\fB$sysfs{\fR\fB\fIfile\fR\fR\fB}\fR, \fB%s{\fR\fB\fIfile\fR\fR\fB}\fR
+\fB$attr{\fR\fB\fIfile\fR\fR\fB}\fR, \fB%s{\fR\fB\fIfile\fR\fR\fB}\fR
 The value of a sysfs attribute found at the current or a parent device.
 .TP 3n
 \fB$env{\fR\fB\fIkey\fR\fR\fB}\fR, \fB%E{\fR\fB\fIkey\fR\fR\fB}\fR
-- 
cgit v1.2.3-54-g00ecf