[PATCH] added more documentation in README and TODO files.

diff --git a/ChangeLog b/ChangeLog
index 6a7969d2986e955779a33fc064552688036adef8..f8b5da0f1df0a085970eea8fe19ebb7b71efc4ee 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1 +1,2 @@
-0.1 - initial release
+0.1 - Added a bit of documentation to the README and TODO files.
+0.01 - initial release

diff --git a/Makefile b/Makefile
index 803a2db569fc51092247c5af36ad4568b477a54f..4e0ca6b3cfa466817b4960411704fa315960cff7 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -22,7 +22,7 @@ DEBUG = true
 
 
 ROOT =         udev
-VERSION =      0.01
+VERSION =      0.1
 INSTALL_DIR =  /usr/local/bin
 RELEASE_NAME = $(ROOT)-$(VERSION)
 

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..1a46a3c
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+
+udev - a userspace implementation of devfs
+
+For more information on the design, and structure of this project, see the
+files in the docs/ directory.
+
+To use:
+
+- Edit the udev.h file and replace the following variables with values
+  that make sense for your system:
+       #define SYSFS_ROOT      "/sys"
+       #define UDEV_ROOT       "/home/greg/linux/udev/"
+       #define DEV_FILE        "/dev"
+       #define MKNOD           "/bin/mknod"
+  The only value most people will have to change is the UDEV_ROOT
+  variable, as I doubt you really want device nodes to be created in my
+  home directory :)
+
+- Run make to build the project.
+
+- Make sure sysfs is mounted.
+
+- Point /proc/sys/kernel/hotplug at the location of the udev binary that
+  is created.  Then plug some block devices in, or other types of
+  devices that create dev files in sysfs.  An easy way to do this,
+  without any hardware is to use the scsi_debug module to create virtual
+  scsi devices.
+
+- Watch as the nodes get created and removed.
+
+
+Yes this is a really rough first cut, I know.  It's mostly a proof of
+concept that this can actually work.  See the TODO file for a list of
+things left to be done.
+
+Any comment/questions/concerns please let me know.
+
+greg k-h
+greg@kroah.com

diff --git a/TODO b/TODO
new file mode 100644 (file)
index 0000000..1f776b9
--- /dev/null
+++ b/TODO
@@ -0,0 +1,6 @@
+- use mknod(2) and not execute mknod(1)
+- add klibc to the build process (or make it easier to do) to get
+  smaller binary
+- make program work like design says it should (three parts, not 1)
+- add hooks to call D-BUS when new node is created or removed
+- lots of other stuff...