chiark / gitweb /
udev_device_get_parent_with_subsystem_devtype(): Clarify documentation
[elogind.git] / README
1 udev - userspace device management
2
3 Integrating udev in the system has complex dependencies and differs from distro
4 to distro. All major distros depend on udev these days and the system may not
5 work without a properly installed version. The upstream udev project does not
6 recommend to replace a distro's udev installation with the upstream version.
7
8 Tools and rules shipped by udev are not public API and may change at any time.
9 Never call any private tool in /lib/udev from any external application, it might
10 just go away in the next release. Access to udev information is only offered
11 by udevadm and libudev. Tools and rules in /lib/udev, and the entire content of
12 the /dev/.udev directory is private to udev and does change whenever needed.
13
14 Requirements:
15   - Version 2.6.27 of the Linux kernel with sysfs, procfs, signalfd, inotify,
16     unix domain sockets, networking and hotplug enabled:
17       CONFIG_HOTPLUG=y
18       CONFIG_UEVENT_HELPER_PATH=""
19       CONFIG_NET=y
20       CONFIG_UNIX=y
21       CONFIG_SYSFS=y
22       CONFIG_SYSFS_DEPRECATED*=n
23       CONFIG_PROC_FS=y
24       CONFIG_TMPFS=y
25       CONFIG_INOTIFY_USER=y
26       CONFIG_SIGNALFD=y
27       CONFIG_TMPFS_POSIX_ACL=y (user ACLs for device nodes)
28       CONFIG_BLK_DEV_BSG=y (SCSI devices)
29
30   - For reliable operations, the kernel must not use the CONFIG_SYSFS_DEPRECATED*
31     option.
32
33   - Unix domain sockets (CONFIG_UNIX) as a loadable kernel module may work,
34     but it is not supported.
35
36   - The proc filesystem must be mounted on /proc, the sysfs filesystem must
37     be mounted at /sys. No other locations are supported by udev.
38
39   - The system must have the following group names resolvable at udev startup:
40       disk, cdrom, floppy, tape, audio, video, lp, tty, dialout, kmem.
41     Especially in LDAP setups, it is required, that getgrnam() is able to resolve
42     these group names with only the rootfs mounted, and while no network is
43     available.
44
45   - To build all udev extras, libacl, libglib2, libusb, usbutils, pciutils,
46     gperf are needed. These dependencies can be disabled with the
47     --disable-extras option.
48
49 Operation:
50   Udev creates and removes device nodes in /dev, based on events the kernel
51   sends out on device discovery or removal.
52
53   - Early in the boot process, the /dev directory should get a 'tmpfs'
54     filesystem mounted, which is maintained by udev. Created nodes or changed
55     permissions will not survive a reboot, which is intentional.
56
57   - The content of /lib/udev/devices directory which contains the nodes,
58     symlinks and directories, which are always expected to be in /dev, should
59     be copied over to the tmpfs mounted /dev, to provide the required nodes
60     to initialize udev and continue booting.
61
62   - The deprecated hotplug helper /sbin/hotplug should be disabled in the
63     kernel configuration, it is not needed today, and may render the system
64     unusable because the kernel may create too many processes in parallel
65     so that the system runs out-of-memory.
66
67   - All kernel events are matched against a set of specified rules in
68     /lib/udev/rules.d which make it possible to hook into the event
69     processing to load required kernel modules and setup devices. For all
70     devices the kernel exports a major/minor number, udev will create a
71     device node with the default kernel name, or the one specified by a
72     matching udev rule.
73
74 Please direct any comment/question to the linux-hotplug mailing list at:
75   linux-hotplug@vger.kernel.org
76