[PATCH] add libsysfs docs

[elogind.git] / README

diff --git a/README b/README
index ed25a733ab7ac5da0de8461efe1bc655b822c2c9..dab0ab4197abd3a33047ff21173647372f83cf64 100644 (file)
--- a/README
+++ b/README
@@ -25,6 +25,27 @@ To use:
 - Build the project:
        make
 
+  Note:
+      There are a number of different flags that you can use when building
+      udev.  They are as follows:
+       prefix - set this to the default root that you want udev to be
+               installed into.  This works just like the 'configure --prefix'
+               script does.  Default value is ''.  Only override this if you
+               really know what you are doing.
+       USE_KLIBC - if set to 'true', udev is built and linked against the included
+               version of klibc.  Default value is 'false'.
+       DEBUG - if set to 'true', debugging messages will be sent to the syslog
+               as udev is run.  Default value is 'false'.
+       USE_DBUS -  if set to 'true', DBUS messages will be sent everytime udev
+               creates or removes a device node.  This requires that DBUS
+               development headers and libraries be present on your system to
+               build properly.  Default value is 'false'.
+
+      So, if you want to build udev using klibc with debugging messages, you
+      would do:
+       make USE_KLIBC=true DEBUG=true
+
+
 - Install the project:
        make install
 
@@ -45,8 +66,17 @@ Things are still quite rough, and it's a bit beyond proof of concept
 code.  Help is very much appreciated, see the TODO file for a list of
 things left to be done.
 
+If you want to build using klibc, use the Makefile.klibc file:
+       - read the klibc/klibc/README file for how to set up the linux
+         symlink properly.
+       - make clean
+       - make -f Makefile.klibc
+and marvel at the tiny binary you just created :)
+
 Any comment/questions/concerns please let me know.
 
 greg k-h
 greg@kroah.com
 
+
+