Merge keymap building in the top-level Makefile.am.

[elogind.git] / README

diff --git a/README b/README
index a14e5c0fcff04e40b81ab462d236aa12d99fab8e..591e03a057a96a0d244ba5e3978c42b43f642c70 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,31 @@
 udev - userspace device management
 
-For more information see the files in the docs/ directory.
+Integrating udev in the system has complex dependencies and differs from distro
+to distro. All major distros depend on udev these days and the system may not
+work without a properly installed version. The upstream udev project does not
+recommend to replace a distro's udev installation with the upstream version.
 
-Important Note:
-  Integrating udev in the system has complex dependencies and differs from distro
-  to distro. All major distros depend on udev these days and the system may not
-  work without a properly installed version. The upstream udev project does not
-  recommend to replace a distro's udev installation with the upstream version.
+Tools and rules shipped by udev are not public API and may change at any time.
+Never call any private tool in /lib/udev from any external application, it might
+just go away in the next release. Access to udev information is only offered
+by udevadm and libudev. Tools and rules in /lib/udev and the entire content of
+/dev/.udev/ is private to udev.
 
 Requirements:
   - Version 2.6.25 of the Linux kernel with sysfs, procfs, signalfd, inotify,
-    unix domain sockets, networking and hotplug enabled.
+    unix domain sockets, networking and hotplug enabled:
+      CONFIG_HOTPLUG=y
+      CONFIG_UEVENT_HELPER_PATH=""
+      CONFIG_NET=y
+      CONFIG_UNIX=y
+      CONFIG_SYSFS=y
+      CONFIG_SYSFS_DEPRECATED*=n
+      CONFIG_PROC_FS=y
+      CONFIG_TMPFS=y
+      CONFIG_INOTIFY=y
+      CONFIG_SIGNALFD=y
+      CONFIG_TMPFS_POSIX_ACL=y (user ACLs for device nodes)
+      CONFIG_BLK_DEV_BSG=y (SCSI tape devices)
 
   - For reliable operation, the kernel must not use the CONFIG_SYSFS_DEPRECATED*
     option.
@@ -27,6 +42,10 @@ Requirements:
     these group names with only the rootfs mounted, and while no network is
     available.
 
+  - To build all udev extras, libacl, libglib2, libusb, usbutils, pciutils,
+    gperf are needed. These dependencies can be disabled with the
+    --disable-extras option.
+
 Operation:
   Udev creates and removes device nodes in /dev/, based on events the kernel
   sends out on device discovery or removal.