summaryrefslogtreecommitdiffstats
path: root/core/tasks
diff options
context:
space:
mode:
authorKhalid Zubair <kzubair@cyngn.com>2016-03-03 11:45:58 -0800
committerKhalid Zubair <kzubair@cyngn.com>2016-03-04 09:45:56 -0800
commit9f2ad7c48905a98704752b9d200a551b07ae7565 (patch)
treee0992264a1e02ac34ffc55bc0a8ea5d7b5d20b1b /core/tasks
parent2b7b9cebc1616d971c92947900293e0daf85e553 (diff)
downloadbuild-9f2ad7c48905a98704752b9d200a551b07ae7565.zip
build-9f2ad7c48905a98704752b9d200a551b07ae7565.tar.gz
build-9f2ad7c48905a98704752b9d200a551b07ae7565.tar.bz2
kernel: add docs for config vars
Add a header with documentation for the config vars currently in use by the Kernel build. Change-Id: I6930b41d716baabbb16c2f407b6b9fe6e5f2b4c8
Diffstat (limited to 'core/tasks')
-rw-r--r--core/tasks/kernel.mk34
1 files changed, 34 insertions, 0 deletions
diff --git a/core/tasks/kernel.mk b/core/tasks/kernel.mk
index b2907b9..7ce9a8a 100644
--- a/core/tasks/kernel.mk
+++ b/core/tasks/kernel.mk
@@ -12,7 +12,41 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+
# Android makefile to build kernel as a part of Android Build
+#
+# Configuration
+# =============
+#
+# These config vars are usually set in BoardConfig.mk:
+#
+# TARGET_KERNEL_SOURCE = Kernel source dir, optional, defaults
+# to kernel/$(TARGET_DEVICE_DIR)
+# TARGET_KERNEL_CONFIG = Kernel defconfig
+# TARGET_KERNEL_VARIANT_CONFIG = Variant defconfig, optional
+# TARGET_KERNEL_SELINUX_CONFIG = SELinux defconfig, optional
+# TARGET_KERNEL_ADDITIONAL_CONFIG = Additional defconfig, optional
+# TARGET_KERNEL_ARCH = Kernel Arch
+# TARGET_KERNEL_HEADER_ARCH = Optional Arch for kernel headers if
+# different from TARGET_KERNEL_ARCH
+# TARGET_USES_UNCOMPRESSED_KERNEL = 'true' if Kernel is uncompressed,
+# optional, defaults to false
+# TARGET_KERNEL_CROSS_COMPILE_PREFIX = Compiler prefix (e.g. aarch64-linux-android-)
+# defaults to arm-eabi-
+#
+# BOARD_KERNEL_IMAGE_NAME = Built image name, optional,
+# defaults to Image.gz on arm64
+# defaults to Image if TARGET_USES_UNCOMPRESSED_KERNEL
+# defaults to zImage otherwise
+#
+# KERNEL_TOOLCHAIN = Path to toolchain, if unset, assumes
+# TARGET_KERNEL_CROSS_COMPILE_PREFIX
+# is in PATH
+# USE_CCACHE = Enable ccache (global Android flag)
+#
+# NEED_KERNEL_MODULE_ROOT = Optional, if true, install kernel
+# modules in root instead of system
+
TARGET_AUTO_KDIR := $(shell echo $(TARGET_DEVICE_DIR) | sed -e 's/^device/kernel/g')