Merge pull request #557 from tych0/dont-mask-system-cpu

[mirror_lxcfs.git] / README.md

diff --git a/README.md b/README.md
index 381b4e49f04c249ae9c5e3a7a89bcaf17acaa3a1..2db345b409e4650781c3429b227464e7ee08f2b7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -70,6 +70,12 @@ versions:
     meson compile -C build/
     sudo meson install -C build/
 
+To build with sanitizers you have to specify `-Db_sanitize=...` option to `meson setup`.
+For example, to enable ASAN and UBSAN:
+
+    meson setup -Dinit-script=systemd --prefix=/usr build/ -Db_sanitize=address,undefined
+    meson compile -C build/
+
 ## Usage
 The recommended command to run lxcfs is:
 
@@ -103,6 +109,7 @@ docker run -it -m 256m --memory-swap 256m \
       -v /var/lib/lxcfs/proc/swaps:/proc/swaps:rw \
       -v /var/lib/lxcfs/proc/uptime:/proc/uptime:rw \
       -v /var/lib/lxcfs/proc/slabinfo:/proc/slabinfo:rw \
+      -v /var/lib/lxcfs/sys/devices/system/cpu:/sys/devices/system/cpu:rw \
       ubuntu:18.04 /bin/bash
  ```