INSTALL

   1 Mauro Carvalho Chehab                                   2006 Apr 26
   2
   3 V4L/DVB building procedures are based at the use of Makefile rules.
   4 Those rules are close to the ones at Linux Kernel, to allow an easier
   5 usage.
   6
   7 =======================================================================
   8 Quick building procedure is:
   9         make all
  10 ======================================================================
  11
  12 For those who may want more than just build all stuff there are some
  13 other interesting parameters to make:
  14
  15 ======================
  16 Normal building rules:
  17 all             - build all modules
  18
  19 clean           - Cleans compiled files from the tree,
  20                   but keeping the latest
  21                   used configuration and kernel version
  22
  23 distclean       - Cleans compiled files from the tree,
  24                   latest used configuration and kernel
  25                   version.
  26
  27 default         - Continues building the latest module selection
  28                   This is the behavior when just typed:
  29                         make
  30
  31 install         - Installs all modules at kernel's default dir
  32                   for V4L/DVB. Requires root access.
  33
  34 rminstall       - cleans previous installations of V4L/DVB modules
  35
  36 sound-install   - installs the sound modules related to V4L/DVB
  37                   tree.
  38
  39 ======================
  40 Firmware rules:
  41
  42 firmware        - Create the firmware files that are enclosed at the
  43                   tree.
  44                   Notice: Only a very few firmwares are currently here
  45
  46 firmware_install- Install firmware files under /lib/firmware
  47
  48 =======================
  49 Module selection rules:
  50 (Those may require write access to kernel tree)
  51
  52 allmodconfig    - Called by make all. Selects all modules that are known
  53                   to compile against the kernel version used.
  54
  55 stagingconfig   - Select all modules, plus all staging modules. The
  56                   staging drivers are there because they may have
  57                   bad userspace API's, serious bugs and/or not fill
  58                   into Kernel required level of quality. So, be
  59                   careful with those drivers.
  60
  61 xconfig         - Generate a xconfig menu. Requires full
  62                   kernel source, since it depends on kernel's
  63                   qconf stript;
  64
  65 gconfig         - Generate a qt menu. Requires full
  66                   kernel source, since it depends on kernel's
  67                   gconf stript;
  68
  69 config          - Generate a text-mode menu. Requires full
  70                   kernel source, since it depends on kernel's
  71                   conf stript;
  72
  73 menuconfig      - Generate a ncurses menu. Requires full
  74                   kernel source, since it depends on kernel's
  75                   mconf and lxconfig stripts;
  76
  77 release         - Allows changing kernel version.
  78                   Typical usage is:
  79                         make release VER=2.6.12-18mdk
  80                         (to force compiling to 2.6.12-18mdk)
  81                         (This will work only if
  82                          /lib/modules/2.6.12-18mdk/build/
  83                          points to that kernel version)
  84                   Or
  85                         make release DIR=~/linux-git
  86                         (to force using kernel at a specific dir)
  87                   To use current kernel version instead:
  88                         make release
  89
  90 ======================
  91 Module handling rules:
  92 (require root access)
  93
  94 insmod          - inserts all modules from V4L/DVB tree
  95
  96 rmmod           - removes all modules from V4L/DVB tree
  97
  98 reload          - removes then reinserts all modules
  99
 100 ===================
 101 Tree merging rules:
 102
 103 ivtv            - enable merged ivtv build, using the latest ivtv sources
 104                   from ivtvdriver.org (requires subversion)
 105
 106 cx88-ivtv       - enable cx88-blackbird ivtv API emulation
 107
 108 ivtv-update     - update ivtv sources from ivtvdriver.org
 109
 110 ==========================================
 111 Patch preparation and tree handling rules:
 112 (used by developers)
 113
 114 kernel-links    - Generate links to V4L/DVB at kernel tree.
 115                   Requires write access to kernel tree.
 116
 117 cardlist        - Updates Documentation/video4linux/CARDLIST.*
 118
 119 update          - updates the tree from master repository
 120
 121 commit          - commits the change, asking for a commit msg
 122
 123 push            - sends outgoing stuff to master repository
 124
 125 checkemacs      - checks codingstyle and reports to emacs
 126                   using "make checkemacs" at emacs compile menu,
 127                   will report the lines with errors inside emacs.
 128
 129 checkpatch      - checks codingstyle and reports using the same
 130                   format as c. This way, c error parsers will
 131                   handle it.
 132
 133 checkterse      - checks codingstyle and reports using terse
 134                   syntax, used on several compilaton tools.
 135
 136 mismatch        - checks for linker section mismatch. In other words,
 137                   check if some driver has functions not properly
 138                   declared with __init/__exit, and similar tags.
 139                   It will also be more pedantic by dealing with
 140                   compilation warnings as if they are errors.