mtd/html index.html,1.28,1.29

[gleixner at infradead.org]

Update of /home/cvs/mtd/html
In directory phoenix.infradead.org:/tmp/cvs-serv30681

Modified Files:
	index.html 
Log Message:
Added a section about installation

Index: index.html
===================================================================
RCS file: /home/cvs/mtd/html/index.html,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- index.html	3 May 2002 14:54:45 -0000	1.28
+++ index.html	8 Mar 2003 18:32:20 -0000	1.29
@@ -69,6 +69,37 @@
 	ftp://ftp.uk.linux.org/pub/people/dwmw2/mtd/cvs/</A>
       </P>
     <HR size=2>
+    <H2>Installation</H2>
+    <P>Check out sources from CVS or download a snapshot and untar it. Change to the
+       top directory and read INSTALL. Change to subdir patches. There you find a script <B>patchin.sh</B>.
+       It is highly <B>recommended</B> to use this script, as it is aware of different kernel versions,
+       pristine or already patched kernels.
+       This script applies all the neccecary changes to your kernel source <B>including</B> the often discussed
+       <B>shared zlib patches</B>. Your kernel source must be configured already, as the script retrieves 
+       information from Makefile in your kernel source.<br>
+       The script takes following options: <br>
+       <I>
+       -c copy files into kernel tree instead of linking files<br>
+       -j include jffs(2) filesystems<br>
+       </I>
+       As last argument you have to give the path of your kernel tree. This must be an absolute
+       path.</P>
+       <P>The difference between linking and copying files into the kernel tree is, that copying 
+       gives you a modified kernel tree, which can be handled by CVS as it contains no symlinks.
+       Linking the files has two advantages. <br>
+       1. All your kernel trees can share the same MTD source.<br>
+       2. You can have more than one MTD source eg. a stable and an unstable and use it with
+       your kernel tree(s) by changing the link to the directories.
+       Assumed you have two MTD versions (stable and unstable) and those are located in source,
+       then the directory listing of source shows:<br>
+       <I>
+       mtd->/source/mtd.stable<br>
+       mtd.stable<br>
+       mtd.unstable<br>
+       </I>
+       If you want to build with your stable MTD source, set the mtd link to mtd.stable else to 
+       mtd.unstable. Don't forget to make clean, if you switch the links.   	       
+    <HR size=2>
     <H2>Documentation</H2>
     <P>There is now some <A HREF="tech/">MTD API documentation</A> available.
       It's a little out of date - the API has been evolving over the last
@@ -78,7 +109,7 @@
       <br><br>13th Feb 2001: A <A HREF="ftp://ftp.uk.linux.org/pub/people/dwmw2/mtd/cvs/mtd/mtd-jffs-HOWTO.txt">mtd-jffs-HOWTO</A> is now also available under
     CVS. Not all topics are covered yet, but it's a start.
       <br><br>5th May 2002: A <A HREF="tech/nand.html">NAND Flash</A> document is now available. It covers
-      some technical topics abaout NAND and filesystems and contains a HOWTO.
+      some technical topics about NAND and filesystems and contains a HOWTO.
     </P>
 
     <HR size=2>