README: note that installing valgrind-devel maybe useful to developers (#6502)
authorMichal Sekletar <msekletar@users.noreply.github.com>
Wed, 30 Aug 2017 11:07:43 +0000 (13:07 +0200)
committerLennart Poettering <lennart@poettering.net>
Wed, 30 Aug 2017 11:07:43 +0000 (13:07 +0200)
Commit also mentions that when running under valgrind we actually don't
execve() systemd-shutdown. We have a comment about this in the code, but
being upfront about this change in behavior doesn't hurt.

README

diff --git a/README b/README
index 5ebaf95..c579ccb 100644 (file)
--- a/README
+++ b/README
@@ -291,9 +291,12 @@ WARNINGS:
         https://www.freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
 
         To run systemd under valgrind, compile with VALGRIND defined
-        (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
-        false positives will be triggered by code which violates
-        some rules but is actually safe.
+        (e.g. CPPFLAGS='... -DVALGRIND=1' meson <options>) and have valgrind
+        development headers installed (i.e. valgrind-devel or
+        equivalent). Otherwise, false positives will be triggered by code which
+        violates some rules but is actually safe. Note that valgrind generates
+        nice output only on exit(), hence on shutdown we don't execve()
+        systemd-shutdown.
 
 ENGINEERING AND CONSULTING SERVICES:
         Kinvolk (https://kinvolk.io) offers professional engineering