Some improvements at Makefile

From: Mauro Carvalho Chehab <mchehab@infradead.org>

Included a INSTALL file
make help shows the INSTALL file
added make release to force compiling against a specified version

Signed-off-by: Mauro Carvalho Chehab <mchehab@infradead.org>

1 files changed, 99 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 000000000..28ea51ef7
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,99 @@
+Mauro Carvalho Chehab                                   2006 Apr 26
+
+V4L/DVB building procedures are based at the use of Makefile rules.
+Those rules are close tho the ones at Linux Kernel, to allow an easier
+usage. 
+
+=======================================================================
+Quick building procedure is:
+	make all
+======================================================================
+
+For those that may want more than just build all stuff there are some
+other interesting parameters to make:
+
+======================
+Normal building rules:
+all		- build all modules
+
+clean		- Cleans compiled files from the tree,
+		  but keeping the latest
+		  used configuration and kernel version
+
+distclean	- Cleans compiled files from the tree,
+		  latest used configuration and kernel
+		  version.
+
+default		- Continues building the latest module selection
+		  This is the behavior when just typed:	
+			make
+
+install		- Installs all modules at kernel's default dir
+		  for V4L/DVB. Requires root access.
+
+=======================
+Module selection rules:
+(Those may require write access to kernel tree)
+
+allmodconfig	- Called by make all. Selects all modules that are known
+		  to compile against the kernel version used.
+
+xconfig		- Generate a xconfig menu. Requires full
+		  kernel source, since it depends on kernel's
+		  qconf stript;
+
+gconfig		- Generate a qt menu. Requires full
+		  kernel source, since it depends on kernel's
+		  gconf stript;
+
+config		- Generate a text-mode menu. Requires full
+		  kernel source, since it depends on kernel's
+		  conf stript;
+
+menuconfig	- Generate a ncurses menu. Requires full
+		  kernel source, since it depends on kernel's
+		  mconf and lxconfig stripts;
+
+release		- Allows changing kernel version. 
+		  Typical usage is:
+			make release VER=2.6.12-18mdk
+			(to force compiling to 2.6.12-18mdk)
+		  This will work only if 
+			/lib/modules/2.6.12-18mdk/build/
+		  points to that kernel version
+		  To use current kernel version instead:
+			make release
+
+======================
+Module handling rules:
+(require root access)
+
+insmod		- inserts all modules from V4L/DVB tree
+
+rmmod		- removes all modules from V4L/DVB tree
+
+reload		- removes then reinserts all modules
+
+===================
+Tree merging rules:
+
+ivtv-checkout	- retrieve latest ivtv sources from the site
+
+ivtv-update	- updates from ivtv sources
+
+ivtv		- Prepare ivtv to compile with the tree
+
+==========================================
+Patch preparation and tree handling rules:
+(used by developers)
+
+kernel-links	- Generate links to V4L/DVB at kernel tree.
+		  Requires write access to kernel tree.
+
+cardlist	- Updates Documentation/video4linux/CARDLIST.*
+
+update		- updates the tree from master repository
+
+commit		- commits the change, asking for a commit msg
+
+push		- sends outgoing stuff to master repository