summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgreg@kroah.com <greg@kroah.com>2003-04-10 15:56:20 -0700
committerGreg KH <gregkh@suse.de>2005-04-26 21:01:38 -0700
commitd2ce1817117daa9523b1572523f1e7684bae779f (patch)
tree6130dde6c2cc9f44af5d52bdbdcc168b0ff289b3
parent1c8c0f62121ea0069f12af252384f66178fc7b07 (diff)
[PATCH] added more documentation in README and TODO files.
-rw-r--r--ChangeLog3
-rw-r--r--Makefile2
-rw-r--r--README39
-rw-r--r--TODO6
4 files changed, 48 insertions, 2 deletions
diff --git a/ChangeLog b/ChangeLog
index 6a7969d298..f8b5da0f1d 100644
--- 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 803a2db569..4e0ca6b3cf 100644
--- 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
index 0000000000..1a46a3c1ee
--- /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
index 0000000000..1f776b9142
--- /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...