core: include partition label in .device description fields

[elogind.git] / README

diff --git a/README b/README
index 2321849356deca65065614935614e5a473eb9462..7a227e7327f0bbf12c9c99a330cbf8f1bd5a683e 100644 (file)
--- a/README
+++ b/README
@@ -30,8 +30,9 @@ AUTHOR:
 
 LICENSE:
         LGPLv2.1+ for all code
 
 LICENSE:
         LGPLv2.1+ for all code

-        - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
-        - except src/shared/MurmurHash3.c which is Public Domain
+        - except sd-readahead.[ch] which is MIT
+        - except src/shared/MurmurHash2.c which is Public Domain
+        - except src/shared/siphash24.c which is CC0 Public Domain

         - except src/journal/lookup3.c which is Public Domain
         - except src/udev/* which is (currently still) GPLv2, GPLv2+
 
         - except src/journal/lookup3.c which is Public Domain
         - except src/udev/* which is (currently still) GPLv2, GPLv2+
 


@@ -45,6 +46,8 @@ REQUIREMENTS:
           CONFIG_EPOLL
           CONFIG_NET
           CONFIG_SYSFS
           CONFIG_EPOLL
           CONFIG_NET
           CONFIG_SYSFS

+          CONFIG_PROC_FS
+          CONFIG_FHANDLE (libudev, mount and bind mount handling)

 
         Linux kernel >= 3.8 for Smack support
 
 
         Linux kernel >= 3.8 for Smack support
 


@@ -61,9 +64,6 @@ REQUIREMENTS:
         Some udev rules and virtualization detection relies on it:
           CONFIG_DMIID
 
         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
         Support for some SCSI devices serial number retrieval, to
         create additional symlinks in /dev/disk/ and /dev/tape:
           CONFIG_BLK_DEV_BSG


@@ -75,9 +75,7 @@ REQUIREMENTS:
           CONFIG_TMPFS_XATTR
           CONFIG_SECCOMP
 
           CONFIG_TMPFS_XATTR
           CONFIG_SECCOMP
 

-        For systemd-bootchart, a kernel with procfs support and
-        several proc output options enabled is required:
-          CONFIG_PROC_FS
+        For systemd-bootchart, several proc debug interfaces are required:

           CONFIG_SCHEDSTATS
           CONFIG_SCHED_DEBUG
 
           CONFIG_SCHEDSTATS
           CONFIG_SCHED_DEBUG
 


@@ -92,8 +90,9 @@ REQUIREMENTS:
         turn it off at kernel compile time using:
           CONFIG_AUDIT=n
 
         turn it off at kernel compile time using:
           CONFIG_AUDIT=n
 

-        dbus >= 1.4.0
+        glibc >= 2.14

         libcap
         libcap

+        libseccomp >= 1.0.0 (optional)

         libblkid >= 2.20 (from util-linux) (optional)
         libkmod >= 15 (optional)
         PAM >= 1.1.2 (optional)
         libblkid >= 2.20 (from util-linux) (optional)
         libkmod >= 15 (optional)
         PAM >= 1.1.2 (optional)


@@ -110,11 +109,16 @@ REQUIREMENTS:
         libpython (optional)
         make, gcc, and similar tools
 
         libpython (optional)
         make, gcc, and similar tools
 

+        To sucessfully use --compat-libs, gcc >= 4.8 seems necessary.
+

         During runtime, you need the following additional
         dependencies:
 
         During runtime, you need the following additional
         dependencies:
 

-        util-linux >= v2.19 (requires fsck -l, agetty -s)
-        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
+        util-linux >= v2.19 (requires fsck -l, agetty -s),
+                      v2.21 required for tests in test/
+        dbus >= 1.4.0 (strictly speaking optional, but recommended)
+        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended,
+                 required for tests in test/)

         dracut (optional)
         PolicyKit (optional)
 
         dracut (optional)
         PolicyKit (optional)
 


@@ -130,8 +134,8 @@ REQUIREMENTS:
         gperf
         gtkdocize (optional)
         python (optional)
         gperf
         gtkdocize (optional)
         python (optional)

+        python-lxml (optional, but required to build the indices)

         sphinx (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


@@ -139,11 +143,6 @@ REQUIREMENTS:
         under all circumstances. In fact, systemd-hostnamed will warn
         if nss-myhostname is not installed.
 
         under all circumstances. In fact, systemd-hostnamed will warn
         if nss-myhostname is not installed.
 

-        Note that D-Bus can link against libsystemd-login.so, which
-        results in a cyclic build dependency. To accommodate for
-        this, please build D-Bus without systemd first, then build
-        systemd, then rebuild D-Bus with systemd support.
-

         To build HTML documentation for python-systemd using sphinx,
         please first install systemd (using 'make install'), and then
         invoke sphinx-build with 'make sphinx-<target>', with <target>
         To build HTML documentation for python-systemd using sphinx,
         please first install systemd (using 'make install'), and then
         invoke sphinx-build with 'make sphinx-<target>', with <target>


@@ -191,6 +190,9 @@ WARNINGS:
         about this, since this kind of file system setup is not really
         supported anymore by the basic set of Linux OS components.
 
         about this, since this kind of file system setup is not really
         supported anymore by the basic set of Linux OS components.
 

+        systemd requires that the /run mount point exists. systemd also
+        requires that /var/run is a a symlink → /run.
+

         For more information on this issue consult
         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
 
         For more information on this issue consult
         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken