Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9f2ad7c4 authored by Khalid Zubair's avatar Khalid Zubair
Browse files

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
parent 2b7b9ceb

core/tasks/kernel.mk

+34 −0
Original line number Diff line number Diff line
@@ -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')