Release LXCFS 6.0.0

[mirror_lxcfs.git] / README.md

diff --git a/README.md b/README.md
index 3c638c381f9d9a2dd9b5ad0b2ca5d4e13f06d44e..2db345b409e4650781c3429b227464e7ee08f2b7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ such as:
 /proc/stat
 /proc/swaps
 /proc/uptime
+/proc/slabinfo
 /sys/devices/system/cpu/online
 ```
 
@@ -43,7 +44,9 @@ To force a reload of the shared library at the next possible instance simply
 send `SIGUSR1` to the pid of the running `LXCFS` process. This can be as simple
 as doing:
 
-    kill -s USR1 $(pidof lxcfs)
+    rm /usr/lib64/lxcfs/liblxcfs.so # MUST to delete the old library file first
+    cp liblxcfs.so /usr/lib64/lxcfs/liblxcfs.so # to place new library file
+    kill -s USR1 $(pidof lxcfs) # reload
 
 ### musl
 
@@ -56,15 +59,22 @@ So users of `LXCFS` on `musl` are advised to restart `LXCFS` completely and all
 containers making use of it.
 
 ## Building
-Build lxcfs as follows:
 
-    yum install fuse fuse-lib fuse-devel
+In order to build LXCFS install fuse and the fuse development headers according
+to your distro. LXCFS prefers `fuse3` but does work with new enough `fuse2`
+versions:
+
     git clone git://github.com/lxc/lxcfs
     cd lxcfs
-    ./bootstrap.sh
-    ./configure
-    make
-    make install
+    meson setup -Dinit-script=systemd --prefix=/usr build/
+    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:
@@ -98,6 +108,8 @@ docker run -it -m 256m --memory-swap 256m \
       -v /var/lib/lxcfs/proc/stat:/proc/stat:rw \
       -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
  ```