summaryrefslogtreecommitdiff
path: root/README.txt
blob: 4025de819f84c25362529585700925a0ef8bb0fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
Why Androgenizer
================

Android has its own GNU make-based build system. However, most developers
would not be happy to add an additional build system to their open source
project (most likely using autotools), as doing it would likely lead to the
build systems diverging at some point. Androgenizer was created to avoid this
situation.

Instead of adding an Android.mk file for each module of your project, you can
now add a single top-level Android.mk for running configure automatically as a
pre-build phase. This completes the autoconf/automake/configure step and
then calls make in the relevant directories to create an Android.mk.

Each Makefile.am from the modules you want to compile on Android gets a small
fragment to generate an Android.mk file using androgenizer. In this call to
androgenizer, SOURCES, CFLAGS, LDFLAGS, LIBADD etc. are provided and used to 
automatically generate the corresponding Android.mk. Since the file is
generated using automake variables, the two builds will remain in sync.

NDK builds and system builds
============================

Sometimes the Android.mk file contents depend on whether the project is
being built with the NDK or as part of a full Android OS distribution, in
the external/ directory. The latter is referred to as a system build.
Androgenizer takes the difference into account.

Androgenizer detects a system build by the ANDROID_BUILD_TOP environment
variable, and if ANDROID_BUILD_TOP is not set or is empty, assumes an
NDK build.

Parameters
==========

At this point, having read the Android build system documentation would be a
good thing. If you have the Android code, look at
build/core/build-system.html. For convenience, this is mirrored at:
http://people.collabora.com/~arun/android/build-system.html

androgenizer takes the following parameters:

-:PROJECT should be called first, and once.

-:SUBDIR adds an -include, expects <project>_TOP variable to be defined

Path substitution for -I statements
-:ABS_TOP sets the absolute path to the source directory
-:REL_TOP sets the relative path to the source directory
Should probably always be used as such:
	-:REL_TOP $(top_srcdir) -:ABS_TOP $(abs_top_srcdir)

Module instantiation:
-:STATIC  creates a new module that will close with BUILD_STATIC_LIBRARY
-:SHARED  creates a new module that will close with BUILD_SHARED_LIBRARY
-:EXECUTABLE creates a new module that will close with BUILD_EXECUTABLE
-:HOST_STATIC  creates a new module that will close with BUILD_HOST_STATIC_LIBRARY
-:HOST_SHARED  creates a new module that will close with BUILD_HOST_SHARED_LIBRARY
-:HOST_EXECUTABLE creates a new module that will close with BUILD_HOST_EXECUTABLE
Multiple modules can be instantiated with a single command line

Adding resources to modules (a module must be declared first!):
-:SOURCES followed by any number of source files

-:CFLAGS followed by any number of flags to pass to the C compiler
-:CXXFLAGS followed by any number of flags to pass to the C++ compiler
-:CPPFLAGS followed by any number of C pre-processor flags

	CPPFLAGS will be passed to both the C and C++ compiler
	CFLAGS will also be passed to *both* the C and C++ compiler
	CXXFLAGS will be passed to just the C++ compiler

	Android uses a different convention - don't be surprised when your
	CXXFLAGS end up in LOCAL_CPPFLAGS in an Android.mk
	There is no way to pass flags to just the C compiler in	the Android
	build system.

	All -I flags in any of CFLAGS, CPPFLAGS or CXXFLAGS will be emitted
	into LOCAL_C_INCLUDES without the "-I".

	some flags are silently removed: -Werror -pthread

-:LDFLAGS followed by any number of linker directives to be processed...
	-l<foo> will be added as lib<foo> to LOCAL_SHARED_LIBRARIES
	-L and -R will be silently removed
	-pthread and -lpthread will be silently removed
	-lrt will be silently removed (rt is a built-in library in bionic)
	-no-undefined will be silently removed
	-dlopen, -version-info, and the word following those
	(the option argument) will be silently removed
	Of plain file arguments, only *.a and *.la files are kept, all others
	are silently dropped.

-:LIBFILTER_STATIC followed by a list of libs (no lib prefix, or extension)
	These libs will be added to LOCAL_STATIC_LIBRARIES instead of
	LOCAL_SHARED_LIBRARIES. Note, that this is just a filter,
	you also need the lib in -:LDFLAGS for it to be linked at all.

-:LIBFILTER_WHOLE followed by a list of libs (no lib prefix, or extension)
	These libs will be added to LOCAL_WHOLE_STATIC_LIBRARIES.
	This is just a filter, see -:LIBFILTER_STATIC.

-:TAGS  must be followed by any number of: optional user eng tests

-:HEADERS followed by any number of headers for LOCAL_COPY_HEADERS

-:HEADER_TARGET sets LOCAL_COPY_HEADERS_TO
	may be followed by multiple strings, but only the last is kept

-:PASSTHROUGH followed by any number of strings to be dumped directly into
	the current module.  eg LOCAL_ARM_MODE:=arm

-:END optional... might go away in the future, was probably a dumb idea.
	ends the current module, but so does starting a new one...

Example
=======

From the gstreamer build for the main libgstreamer-0.10 library.

Android.mk: Makefile.am
	androgenizer -:PROJECT gstreamer \
		     # `-- the name of the project
	 -:SHARED libgstreamer-@GST_MAJORMINOR@ \
	 -:TAGS eng debug \
         -:REL_TOP $(top_srcdir) -:ABS_TOP $(abs_top_srcdir) \
	 -:SOURCES $(libgstreamer_@GST_MAJORMINOR@_la_SOURCES) \
	           $(nodist_libgstreamer_@GST_MAJORMINOR@_la_SOURCES) \
	 -:CFLAGS $(DEFS) $(libgstreamer_@GST_MAJORMINOR@_la_CFLAGS) \
	 -:LDFLAGS $(libgstreamer_@GST_MAJORMINOR@_la_LDFLAGS) \
	           $(libgstreamer_@GST_MAJORMINOR@_la_LIBADD) \
	           -ldl \
	 -:SUBDIR gst/parse \
	 -:HEADER_TARGET gstreamer-@GST_MAJORMINOR@/gst \
	 -:HEADERS $(libgstreamer_@GST_MAJORMINOR@include_HEADERS) \
	 -:LIBFILTER_STATIC gstparse \
	 -:PASSTHROUGH LOCAL_ARM_MODE:=arm \
	> $@