summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL103
1 files changed, 103 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 000000000..d71688cdf
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,103 @@
+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)
+ Or
+ make release DIR=~/linux-git
+ (to force using kernel at a specific dir)
+ 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 - enable merged ivtv build, using the latest ivtv sources
+ from ivtvdriver.org (requires subversion)
+
+cx88-ivtv - enable cx88-blackbird ivtv API emulation
+
+ivtv-update - update ivtv sources from ivtvdriver.org
+
+==========================================
+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