update TODO

[elogind.git] / README

diff --git a/README b/README
index 889c687bacdbe1f6f88cb90ad28663faa2c7f119..b8d1f42e254676193c6aeacc1385d0d98e22bd3f 100644 (file)
--- a/README
+++ b/README
@@ -31,13 +31,54 @@ 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/udev/ which is (currently still) GPLv2+

 
 REQUIREMENTS:
         Linux kernel >= 2.6.39
 
 REQUIREMENTS:
         Linux kernel >= 2.6.39

-                with devtmpfs
-                with cgroups (but it's OK to disable all controllers)
-                optional but strongly recommended: autofs4, ipv6
+          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
+
+        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
+

         dbus >= 1.4.0
         libcap
         libblkid >= 2.20 (from util-linux) (optional)
         dbus >= 1.4.0
         libcap
         libblkid >= 2.20 (from util-linux) (optional)


@@ -63,13 +104,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 +116,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


@@ -101,14 +136,15 @@ REQUIREMENTS:
         pass the same DESTDIR to 'make sphinx-html' invocation.
 
 USERS AND GROUPS:
         pass the same DESTDIR to 'make sphinx-html' invocation.
 
 USERS AND GROUPS:

-        Default udev rules use the following standard system group names,\
-        which need to be resolvable by getgrnam() at any time, even in the
-        very early boot stages, where no other databases and network is
-        available:
-          tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
+        Default udev rules use the following standard system group
+        names, which need to be resolvable by getgrnam() at any time,
+        even in the very early boot stages, where no other databases
+        and network are available:
+
+        tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk

 
         During runtime the journal daemon requires the
 
         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.
 


@@ -119,6 +155,11 @@ USERS AND GROUPS:
 
         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
 
 
         # 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
+        "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.
+

 WARNINGS:
         systemd will warn you during boot if /etc/mtab is not a
         symlink to /proc/mounts. Please ensure that /etc/mtab is a
 WARNINGS:
         systemd will warn you during boot if /etc/mtab is not a
         symlink to /proc/mounts. Please ensure that /etc/mtab is a