Merge po file from 0.8.6
[vlc.git] / HACKING
1 $Id$
2
3 Hacking vlc
4 ===========
5
6 First
7 -----
8
9  - Read this file
10
11  - Read the information present on http://developers.videolan.org/vlc/
12
13
14 Requirements
15 ____________
16
17 You will need the following tools if you plan to use the SVN version of vlc:
18
19  - autoconf version 2.50 or later
20
21  - automake version 1.5 (but 1.6 or later is recommended)
22
23  - gettext version 0.10.40 (but 0.11.3 or later is recommended)
24
25  - perl version 5.005 or later
26
27 After retrieving the SVN tree, you need to run the bootstrap script to
28 generate all the files needed to build vlc. You can then run configure.
29 Run ./configure --help for a description of the available options.
30
31 If you do not have the correct version of these tools, or if they are
32 simply not available for the operating system you plan to develop on,
33 you can check out a SVN tree on an OS that provides these tools (such
34 as a recent Linux distribution), run bootstrap, and then copy the whole
35 tree to your retarded OS.
36
37 There is a possibility that, at some point, automake might segfault. The
38 reason is unsufficient stack size, and can be easily fixed with the
39 `ulimit` command (or an equivalent) available in most shells. For instance
40 on bash 2.0, the following command solves the automake crash on Mac OS X :
41 ulimit -s 20000
42
43
44 The bootstrap sequence
45 ----------------------
46
47 The bootstrap script does the following actions:
48
49  - parse configure.ac for all Makefiles in the modules/ directory that need
50    to be generated, and look for available modules in the corresponding
51    Modules.am file. A module "foo" exists if there is a Modules.am file in
52    the modules/ directory which defines SOURCES_foo.
53
54  - create a top-level Modules.am file (which will be included by Makefile.am)
55    which contains additional build rules for modules, and includes all the
56    Modules.am files that were found in modules/
57
58  - create an m4/private.m4 from configure.ac, generating m4 macros that will
59    be needed by configure.ac.
60
61  - create a Makefile.am file for each Modules.am file found in modules/ .
62
63  - run autopoint (previously gettextize) to create an intl/ directory,
64    needed when libgettext is not available.
65
66  - run the usual aclocal, autoheader, automake and autoconf, which create
67    the various Makefile.in files from the corresponding Makefile.am and the
68    configure script from configure.ac.
69
70  - fix a few files in the vlc repository that may have been altered.
71
72
73 How to add a module
74 -------------------
75
76 To add a module to the repository, just add its sources to a Modules.am
77 file. If you add a new directory you will need to create a new Modules.am,
78 inside that directory. Do not forget to add a corresponding
79 Makefile line at the end of configure.ac for this new Modules.am file.
80
81 To have the module built, you need to add a call to VLC_ADD_PLUGINS or
82 VLC_ADD_BUILTINS to configure.ac with your new module name as argument.
83 Look at other modules for guidelines on how to add build and linkage options.
84
85 After changing configure.ac you will always need to rerun bootstrap and 
86 configure.
87
88 VLC keeps a cache of its module (in ~/.vlc/cache on Linux), so you'll have to delete it. (or use vlc --reset-plugins-cache)
89 Then use vlc -vvv --color --list to check that your plugin is seen by VLC.
90