chiark / gitweb /
hashmap: randomize hash functions a bit
[elogind.git] / README
diff --git a/README b/README
index b6e347ec2b33f4d3b82f3475cf8080648c39f5d5..b39cd377dfd43175d9bccdbdbf51af8fbae668d0 100644 (file)
--- a/README
+++ b/README
@@ -31,17 +31,71 @@ AUTHOR:
 LICENSE:
         LGPLv2.1+ for all code
         - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
 LICENSE:
         LGPLv2.1+ for all code
         - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
-        - except src/udev/ which is GPLv2.0+
+        - except src/shared/MurmurHash3.c which is Public Domain
+        - except src/journal/lookup3.c which is Public Domain
+        - except src/udev/* which is (currently still) GPLv2, GPLv2+
 
 REQUIREMENTS:
 
 REQUIREMENTS:
-        Linux kernel >= 2.6.39
-                with devtmpfs
-                with cgroups (but it's OK to disable all controllers)
-                optional but strongly recommended: autofs4, ipv6
+        Linux kernel >= 3.0
+          CONFIG_DEVTMPFS
+          CONFIG_CGROUPS (it's OK to disable all controllers)
+          CONFIG_INOTIFY_USER
+          CONFIG_SIGNALFD
+          CONFIG_TIMERFD
+          CONFIG_EPOLL
+          CONFIG_NET
+          CONFIG_SYSFS
+
+        Linux kernel >= 3.8 for Smack support
+
+        Udev will fail to work with the legacy layout:
+          CONFIG_SYSFS_DEPRECATED=n
+
+        Legacy hotplug slows down the system and confuses udev:
+          CONFIG_UEVENT_HELPER_PATH=""
+
+        Userspace firmware loading is deprecated, will go away, and
+        sometimes causes problems:
+          CONFIG_FW_LOADER_USER_HELPER=n
+
+        Some udev rules and virtualization detection relies on it:
+          CONFIG_DMIID
+
+        Mount and bind mount handling might require it:
+          CONFIG_FHANDLE
+
+        Support for some SCSI devices serial number retrieval, to
+        create additional symlinks in /dev/disk/ and /dev/tape:
+          CONFIG_BLK_DEV_BSG
+
+        Optional but strongly recommended:
+          CONFIG_IPV6
+          CONFIG_AUTOFS4_FS
+          CONFIG_TMPFS_POSIX_ACL
+          CONFIG_TMPFS_XATTR
+          CONFIG_SECCOMP
+
+        For systemd-bootchart a kernel with procfs support and several
+        proc output options enabled is required:
+          CONFIG_PROC_FS
+          CONFIG_SCHEDSTATS
+          CONFIG_SCHED_DEBUG
+
+        For UEFI systems:
+          CONFIG_EFI_VARS
+          CONFIG_EFI_PARTITION
+
+        Note that kernel auditing is broken when used with systemd's
+        container code. When using systemd in conjunction with
+        containers please make sure to either turn off auditing at
+        runtime using the kernel command line option "audit=0", or
+        turn it off at kernel compile time using:
+          CONFIG_AUDIT=n
+
         dbus >= 1.4.0
         libcap
         libblkid >= 2.20 (from util-linux) (optional)
         dbus >= 1.4.0
         libcap
         libblkid >= 2.20 (from util-linux) (optional)
-        libkmod >= 5 (optional)
+        libkmod >= 14 (optional)
         PAM >= 1.1.2 (optional)
         libcryptsetup (optional)
         libaudit (optional)
         PAM >= 1.1.2 (optional)
         libcryptsetup (optional)
         libaudit (optional)
@@ -63,13 +117,6 @@ REQUIREMENTS:
         dracut (optional)
         PolicyKit (optional)
 
         dracut (optional)
         PolicyKit (optional)
 
-        For systmed-bootchart a kernel with procfs support and several
-        proc output options enabled is required:
-
-        CONFIG_PROC_FS
-        CONFIG_SCHEDSTATS
-        CONFIG_SCHED_DEBUG
-
         When building from git you need the following additional dependencies:
 
         docbook-xsl
         When building from git you need the following additional dependencies:
 
         docbook-xsl
@@ -82,6 +129,7 @@ REQUIREMENTS:
         gtkdocize (optional)
         python (optional)
         sphinx (optional)
         gtkdocize (optional)
         python (optional)
         sphinx (optional)
+        python-lxml (entirely optional)
 
         When systemd-hostnamed is used it is strongly recommended to
         install nss-myhostname to ensure that in a world of
 
         When systemd-hostnamed is used it is strongly recommended to
         install nss-myhostname to ensure that in a world of
@@ -109,7 +157,7 @@ USERS AND GROUPS:
         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
 
         During runtime the journal daemon requires the
         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
 
         During runtime the journal daemon requires the
-        "system-journal" system group to exist. New journal files will
+        "systemd-journal" system group to exist. New journal files will
         be readable by this group (but not writable) which may be used
         to grant specific users read access.
 
         be readable by this group (but not writable) which may be used
         to grant specific users read access.
 
@@ -121,7 +169,7 @@ USERS AND GROUPS:
         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
 
         The journal gateway daemon requires the
         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
 
         The journal gateway daemon requires the
-        "system-journal-gateway" system user and group to
+        "systemd-journal-gateway" system user and group to
         exist. During execution this network facing service will drop
         privileges and assume this uid/gid for security reasons.
 
         exist. During execution this network facing service will drop
         privileges and assume this uid/gid for security reasons.