Android.mk文档规范

Android.mk文档规范
Android.mk 编译文件是用来向 Android NDK描述你的
C,C++源代码文件的，

这篇文档描
述了它的语法。在阅读下面的内容之前，假定你已经阅读了 docs/OVERVIEW.TXT 文件，了解
了它们的脚色和用途。
一、概述
一个 Android.mk file 用来向编译系统描述你的源代码。具体来说：
（1）该文件是GNU Makefile的一小部分，
会被编译系统解析一次或更多次的build系统。
因此，您应尽量减少您声明的变量，不要认为某些变量在解析过程中不会被定义。
（2）这个文件的语法允许把你的源代码组织成模块，一个模块属下列类型之一：
1）静态库
2）共享库
且只有共享库将被安装/复制到您的应用软件包，虽然静态库能被用于生成共享库。
可以在每一个 Android.mk file 中定义一个或多个模块，
你也可以在几个模块中使用同一个
源代码文件。
编译系统为你处理许多细节问题。例如，你不需要在你的 Android.mk
中列出头文件和依
赖文件。NDK 编译系统将会为你自动处理这些问题。这也意味着，在升级 NDK 后，你应该
得到新的 toolchain/platform支持，而且不需要改变你的 Android.mk 文件。
注意，这个语法同公开发布的
Android平台的开源代码很接近，然而编译系统实现他们的
方式却是不同的，这是故意这样设计的，可以让程序开发人员重用外部库的源代码更容易。
在描述语法细节之前，咱们来看一个简单的"hello
world"的例子，比如，下面的文件：
sources/helloworld/helloworld.c
sources/helloworld/Android.mk
'helloworld.c'是一个 JNI 共享库，实现返回"hello
world"字符串的原生方法。相应的
Android.mk 文件会象下面这样：
LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)

LOCAL_MODULE:= helloworld

LOCAL_SRC_FILES := helloworld.c

include $(BUILD_SHARED_LIBRARY)

解释一下这几行代码：
LOCAL_PATH := $(call my-dir)
一个Android.mk file首先必须定义好LOCAL_PATH变量。
它用于在开发树中查找源文件。
在这个例子中，宏函数‘my-dir’, 由编译系统提供，
用于返回当前路径(即包含Android.mk file
文件的目录)。

include $(CLEAR_VARS)
CLEAR_VARS 由编译系统提供(可以在 android
安装目录下的/build/core/config.mk 文件看
到其定义，为 CLEAR_VARS:= $(BUILD_SYSTEM)/clear_vars.mk)，指定让 GNU
MAKEFILE
为你清除许多 LOCAL_XXX 变量 ( 例如 LOCAL_MODULE ， LOCAL_SRC_FILES ，
Android.mk 文档规范 2
LOCAL_STATIC_LIBRARIES，等等…)，除 LOCAL_PATH。这是必要的，因为所有的编译控
制文件都在同一个 GNU MAKE 执行环境中，所有的变量都是全局的。

LOCAL_MODULE := helloworld
LOCAL_MODULE 变量必须定义，以标识你在 Android.mk
文件中描述的每个模块。名称
必须是唯一的，而且不包含任何空格。注意编译系统会自动产生合适的前缀和后缀，换句话
说，一个被命名为'foo'的共享库模块，将会生成'libfoo.so'文件。注意：如果把库命名为
‘libhelloworld’，编译系统将不会添加任何的 lib 前缀，也会生成 libhelloworld.so，这是
为了支持来源于 Android平台的源代码的 Android.mk 文件。

LOCAL_SRC_FILES := helloworld.c
LOCAL_SRC_FILES 变量必须包含将要编译打包进模块中的 C 或
C++源代码文件。不用
在这里列出头文件和包含文件，编译系统将会自动找出依赖型的文件。
【注意，默认的 C++源码文件的扩展名是‘.cpp’ 。指定一个不同的扩展名也是可能的，只要定义
LOCAL_DEFAULT_CPP_EXTENSION 变量，不要忘记开始的小圆点(也就是定义为
‘.cxx’,而不是‘cxx’)】

include $(BUILD_SHARED_LIBRARY)
BUILD_SHARED_LIBRARY 是编译系统提供的变量，指向一个 GNU
Makefile 脚本(应该
就是在 build/core 目录下的 shared_library.mk)
，负责收集自从上次调用 'include
$(CLEAR_VARS)'以来，定义在 LOCAL_XXX 变量中的所有信息，并且决定编译什么，如何正
确地去做。并根据其规则生成静态库。同理对于静态库。

在 sources/samples目录下有更复杂一点的例子，写有注释的 Android.mk
文件。
二、参考
这是一份你应该在 Android.mk 中依赖或定义的变量列表，
可以定义其他变量为自己使用，
但是 NDK编译系统保留下列变量名：
-以 LOCAL_开头的名字（例如 LOCAL_MODULE）
-以 PRIVATE_, NDK_ 或 APP_开头的名字（内部使用）
-小写名字（内部使用，例如‘my-dir’）
如果为了方便在 Android.mk 中定义自己的变量，建议使用
MY_前缀，一个小例子：
MY_SOURCES := foo.c

ifneq ($(MY_CONFIG_BAR),)
MY_SOURCES += bar.c
endif

LOCAL_SRC_FILES += $(MY_SOURCES)

1. GNU Make 变量
这些 GNU Make 变量在你的 Android.mk
文件解析之前，就由编译系统定义好了。注意在
某些情况下，NDK可能分析 Android.mk 几次，每一次某些变量的定义会有不同。
（1）CLEAR_VARS:
指向一个编译脚本，几乎所有未定义的 LOCAL_XXX 变量都在
"Module-description"节中列出。必须在开始一个新模块之前包含这个脚本：include
$(CLEAR_VARS)
（2）BUILD_SHARED_LIBRARY:
指向编译脚本，收集