Add nand driver that works with a nand simulator
[yaffs2.git] / README-linux-patch
index 6022358187180603bbdf22b88e968eaacc9ba652..a651cb5df470969328775699535ad1b45db2b603 100644 (file)
@@ -1,14 +1,30 @@
 To build YAFFS in the Linux kernel tree you need to run the patch-ker.sh
-script, giving the path to your kernel sources, e.g:
+script from the yaffs source directory, giving your choice as to whether
+you wish to copy (c) or link (l) the code and the path to your kernel
+sources and whether you want to use the single-version or multi-version
+code. e.g:
 
-./patch-ker.sh /usr/src/linux
+./patch-ker.sh c m /usr/src/linux
 
-This will copy the yaffs files into fs/yaffs2 and modify the Kconfig
+This will copy the yaffs files into /usr/src/linux/fs/yaffs2 and modify the Kconfig
 and Makefiles in the fs directory.
 
+./patch-ker.sh l m /usr/src/linux
+
+This does the same as the above but makes symbolic links instead. This can
+be handy if you are developing yaffs and want to interact with the yaffs git
+repository, make patches, or whatever.
+
+The single-version code is intended to track the current latest Linux kernel
+and does not attempt to support older versions of the kernel.
+
+The multi-version code supports more versions of the Linux kernel. It also
+supports some optional features that might be excluded from the
+single-version code.
+
 After you've run the script, go back to your normal kernel making procedure
 and configure the yaffs settings you want.
 
 Prolems? Contact the yaffs mailing list:
 
-http://www.aleph1.co.uk/mailman/listinfo/yaffs.hmtl
+http://www.aleph1.co.uk/mailman/listinfo/yaffs