git.sesse.net Git - vlc/blob - HACKING

   1 $Id: HACKING,v 1.8 2003/06/27 13:50:07 sam Exp $
   2
   3 Hacking vlc
   4 ===========
   5
   6 Requirements
   7 ------------
   8
   9 You will need the following tools if you plan to use the CVS version of vlc:
  10
  11  - autoconf version 2.50 or later
  12
  13  - automake version 1.5 (but 1.6 or later is recommended)
  14
  15  - gettext version 0.10.40 (but 0.11.3 or later is recommended)
  16
  17 After retrieving the CVS tree, you need to run the bootstrap script to
  18 generate all the files needed to build vlc. You can then run configure.
  19
  20 If you do not have the correct version of these tools, or if they are
  21 simply not available for the operating system you plan to develop on,
  22 you can check out a CVS tree on an OS that provides these tools (such
  23 as a recent Linux distribution), run bootstrap, and then copy the whole
  24 tree to your retarded OS.
  25
  26 There is a possibility that, at some point, automake might segfault. The
  27 reason is unsufficient stack size, and can be easily fixed with the
  28 `ulimit` command (or an equivalent) available in most shells. For instance
  29 on bash 2.0, the following command solves the automake crash on Mac OS X :
  30 ulimit -s 20000
  31
  32
  33 The bootstrap sequence
  34 ----------------------
  35
  36 The bootstrap script does the following actions:
  37
  38  - parse configure.ac for all Makefiles in the modules/ directory that need
  39    to be generated, and look for available modules in the corresponding
  40    Modules.am file. A module "foo" exists if there is a Modules.am file in
  41    the modules/ directory which defines SOURCES_foo.
  42
  43  - create a top-level Modules.am file (which will be included by Makefile.am)
  44    which contains additional build rules for modules, and includes all the
  45    Modules.am files that were found in modules/
  46
  47  - create an m4/private.m4 from configure.ac, generating m4 macros that will
  48    be needed by configure.ac.
  49
  50  - create a Makefile.am file for each Modules.am file found in modules/ .
  51
  52  - run autopoint (previously gettextize) to create an intl/ directory,
  53    needed when libgettext is not available.
  54
  55  - run the usual aclocal, autoheader, automake and autoconf, which create
  56    the various Makefile.in files from the corresponding Makefile.am and the
  57    configure script from configure.ac.
  58
  59  - fix a few files in the vlc repository that may have been altered.
  60
  61
  62 How to add a module
  63 -------------------
  64
  65 To add a module to the repository, just add its sources to a Modules.am
  66 file. If you create a new Modules.am, do not forget to add a corresponding
  67 line to modules/Makefile.am.
  68