systemd-python: some python3 and bug fixes

[elogind.git] / README

diff --git a/README b/README
index 581e84598e7d14ec6ba130363fee2e00278b37a6..1aa044be75f47ace6ec2c43f7a30f5564b04cc8c 100644 (file)
--- a/README
+++ b/README
@@ -61,6 +61,14 @@ REQUIREMENTS:
         util-linux >= v2.19 (requires fsck -l, agetty -s)
         sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
         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:
 
@@ -73,20 +81,25 @@ REQUIREMENTS:
         gperf
         gtkdocize (optional)
         python (optional)
+        sphinx (optional)
 
         When systemd-hostnamed is used it is strongly recommended to
         install nss-myhostname to ensure that in a world of
         dynamically changing hostnames the hostname stays resolvable
         under all circumstances. In fact, systemd-hostnamed will warn
-        if nss-myhostname is not installed. Packagers are encouraged to
-        add a dependency on nss-myhostname to the package that
-        includes systemd-hostnamed.
+        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>
+        being 'html' or 'latexpdf'. If using DESTDIR for installation,
+        pass the same DESTDIR to 'make sphinx-html' invocation.
+
 WARNINGS:
         systemd will warn you during boot if /etc/mtab is not a
         symlink to /proc/mounts. Please ensure that /etc/mtab is a