version_defaults.mk revision a6bc3a8a4cfaa272499503890bc73b82ba61d6cb
1# 2# Copyright (C) 2008 The Android Open Source Project 3# 4# Licensed under the Apache License, Version 2.0 (the "License"); 5# you may not use this file except in compliance with the License. 6# You may obtain a copy of the License at 7# 8# http://www.apache.org/licenses/LICENSE-2.0 9# 10# Unless required by applicable law or agreed to in writing, software 11# distributed under the License is distributed on an "AS IS" BASIS, 12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13# See the License for the specific language governing permissions and 14# limitations under the License. 15# 16 17# 18# Handle various build version information. 19# 20# Guarantees that the following are defined: 21# PLATFORM_VERSION 22# PLATFORM_SDK_VERSION 23# PLATFORM_VERSION_CODENAME 24# DEFAULT_APP_TARGET_SDK 25# BUILD_ID 26# BUILD_NUMBER 27# BUILD_DATETIME 28# PLATFORM_SECURITY_PATCH 29# 30 31# Look for an optional file containing overrides of the defaults, 32# but don't cry if we don't find it. We could just use -include, but 33# the build.prop target also wants INTERNAL_BUILD_ID_MAKEFILE to be set 34# if the file exists. 35# 36INTERNAL_BUILD_ID_MAKEFILE := $(wildcard $(BUILD_SYSTEM)/build_id.mk) 37ifdef INTERNAL_BUILD_ID_MAKEFILE 38 include $(INTERNAL_BUILD_ID_MAKEFILE) 39endif 40 41DEFAULT_PLATFORM_VERSION := OPD1 42MIN_PLATFORM_VERSION := OPD1 43MAX_PLATFORM_VERSION := PPR1 44 45ALLOWED_VERSIONS := $(call allowed-platform-versions,\ 46 $(MIN_PLATFORM_VERSION),\ 47 $(MAX_PLATFORM_VERSION),\ 48 $(DEFAULT_PLATFORM_VERSION)) 49 50ifndef TARGET_PLATFORM_VERSION 51 TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION) 52else ifeq ($(TARGET_PLATFORM_VERSION),OPR1) 53 # HACK: lunch currently sets TARGET_PLATFORM_VERSION to 54 # DEFAULT_PLATFORM_VERSION, which causes unnecessary pain 55 # when the old DEFAULT_PLATFORM_VERSION becomes invalid. 56 # For now, silently upgrade OPR1 to the current default. 57 TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION) 58endif 59 60ifeq (,$(filter $(ALLOWED_VERSIONS), $(TARGET_PLATFORM_VERSION))) 61 $(warning Invalid TARGET_PLATFORM_VERSION '$(TARGET_PLATFORM_VERSION)', must be one of) 62 $(error $(ALLOWED_VERSIONS)) 63endif 64 65# Default versions for each TARGET_PLATFORM_VERSION 66# TODO: PLATFORM_VERSION, PLATFORM_SDK_VERSION, etc. should be conditional 67# on this 68 69# This is the canonical definition of the platform version, 70# which is the version that we reveal to the end user. 71# Update this value when the platform version changes (rather 72# than overriding it somewhere else). Can be an arbitrary string. 73 74# When you add a new PLATFORM_VERSION which will result in a new 75# PLATFORM_SDK_VERSION please ensure you add a corresponding isAtLeast* 76# method in the following java file: 77# frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java 78 79# When you change PLATFORM_VERSION for a given PLATFORM_SDK_VERSION 80# please add that PLATFORM_VERSION to the following text file: 81# cts/tests/tests/os/assets/platform_versions.txt 82PLATFORM_VERSION.OPD1 := 8.0.1 83PLATFORM_VERSION.OPM1 := OMR1 84PLATFORM_VERSION.PPR1 := P 85 86# These are the current development codenames, if the build is not a final 87# release build. If this is a final release build, it is simply "REL". 88PLATFORM_VERSION_CODENAME.OPD1 := REL 89PLATFORM_VERSION_CODENAME.OPM1 := OMR1 90PLATFORM_VERSION_CODENAME.PPR1 := P 91 92ifndef PLATFORM_VERSION 93 PLATFORM_VERSION := $(PLATFORM_VERSION.$(TARGET_PLATFORM_VERSION)) 94 ifndef PLATFORM_VERSION 95 # PLATFORM_VERSION falls back to TARGET_PLATFORM_VERSION 96 PLATFORM_VERSION := $(TARGET_PLATFORM_VERSION) 97 endif 98endif 99 100ifndef PLATFORM_SDK_VERSION 101 # This is the canonical definition of the SDK version, which defines 102 # the set of APIs and functionality available in the platform. It 103 # is a single integer that increases monotonically as updates to 104 # the SDK are released. It should only be incremented when the APIs for 105 # the new release are frozen (so that developers don't write apps against 106 # intermediate builds). During development, this number remains at the 107 # SDK version the branch is based on and PLATFORM_VERSION_CODENAME holds 108 # the code-name of the new development work. 109 110 # When you change PLATFORM_SDK_VERSION please ensure you also update the 111 # corresponding methods for isAtLeast* in the following java file: 112 # frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java 113 114 # When you increment the PLATFORM_SDK_VERSION please ensure you also 115 # clear out the following text file of all older PLATFORM_VERSION's: 116 # cts/tests/tests/os/assets/platform_versions.txt 117 PLATFORM_SDK_VERSION := 26 118endif 119 120ifndef PLATFORM_VERSION_CODENAME 121 PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION)) 122 ifndef PLATFORM_VERSION_CODENAME 123 # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION 124 PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION) 125 endif 126 127 # This is all of the *active* development codenames. There are future 128 # codenames not included in this list. This confusing name is needed because 129 # all_codenames has been baked into build.prop for ages. 130 # 131 # Should be either the same as PLATFORM_VERSION_CODENAME or a comma-separated 132 # list of additional codenames after PLATFORM_VERSION_CODENAME. 133 PLATFORM_VERSION_ALL_CODENAMES := 134 135 # Build a list of all active code names. Avoid duplicates, and stop when we 136 # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond 137 # that is not included in our build). 138 _versions_in_target := \ 139 $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION)) 140 $(foreach version,$(_versions_in_target),\ 141 $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\ 142 $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\ 143 $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename)))) 144 145 # This is all of the inactive development codenames. Available to be targeted 146 # in this branch but in the future relative to our current target. 147 PLATFORM_VERSION_FUTURE_CODENAMES := 148 149 # Build a list of all untargeted code names. Avoid duplicates. 150 _versions_not_in_target := \ 151 $(filter-out $(PLATFORM_VERSION_ALL_CODENAMES),$(ALL_VERSIONS)) 152 $(foreach version,$(_versions_not_in_target),\ 153 $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\ 154 $(if $(filter $(_codename),$(PLATFORM_VERSION_FUTURE_CODENAMES)),,\ 155 $(eval PLATFORM_VERSION_FUTURE_CODENAMES += $(_codename)))) 156 157 # And convert from space separated to comma separated. 158 PLATFORM_VERSION_ALL_CODENAMES := \ 159 $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES))) 160 PLATFORM_VERSION_FUTURE_CODENAMES := \ 161 $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_FUTURE_CODENAMES))) 162 163endif 164 165ifeq (REL,$(PLATFORM_VERSION_CODENAME)) 166 PLATFORM_PREVIEW_SDK_VERSION := 0 167else 168 ifndef PLATFORM_PREVIEW_SDK_VERSION 169 # This is the definition of a preview SDK version over and above the current 170 # platform SDK version. Unlike the platform SDK version, a higher value 171 # for preview SDK version does NOT mean that all prior preview APIs are 172 # included. Packages reading this value to determine compatibility with 173 # known APIs should check that this value is precisely equal to the preview 174 # SDK version the package was built for, otherwise it should fall back to 175 # assuming the device can only support APIs as of the previous official 176 # public release. 177 # This value will always be 0 for release builds. 178 PLATFORM_PREVIEW_SDK_VERSION := 1 179 endif 180endif 181 182ifndef DEFAULT_APP_TARGET_SDK 183 # This is the default minSdkVersion and targetSdkVersion to use for 184 # all .apks created by the build system. It can be overridden by explicitly 185 # setting these in the .apk's AndroidManifest.xml. It is either the code 186 # name of the development build or, if this is a release build, the official 187 # SDK version of this release. 188 ifeq (REL,$(PLATFORM_VERSION_CODENAME)) 189 DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION) 190 else 191 DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME) 192 endif 193endif 194 195ifndef PLATFORM_SECURITY_PATCH 196 # Used to indicate the security patch that has been applied to the device. 197 # It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin. 198 # It must be of the form "YYYY-MM-DD" on production devices. 199 # It must match one of the Android Security Patch Level strings of the Public Security Bulletins. 200 # If there is no $PLATFORM_SECURITY_PATCH set, keep it empty. 201 PLATFORM_SECURITY_PATCH := 2017-10-05 202endif 203 204ifndef PLATFORM_BASE_OS 205 # Used to indicate the base os applied to the device. 206 # Can be an arbitrary string, but must be a single word. 207 # 208 # If there is no $PLATFORM_BASE_OS set, keep it empty. 209 PLATFORM_BASE_OS := 210endif 211 212ifndef BUILD_ID 213 # Used to signify special builds. E.g., branches and/or releases, 214 # like "M5-RC7". Can be an arbitrary string, but must be a single 215 # word and a valid file name. 216 # 217 # If there is no BUILD_ID set, make it obvious. 218 BUILD_ID := UNKNOWN 219endif 220 221ifndef BUILD_DATETIME 222 # Used to reproduce builds by setting the same time. Must be the number 223 # of seconds since the Epoch. 224 BUILD_DATETIME := $(shell date +%s) 225endif 226 227ifneq (,$(findstring Darwin,$(UNAME))) 228DATE := date -r $(BUILD_DATETIME) 229else 230DATE := date -d @$(BUILD_DATETIME) 231endif 232 233ifndef BUILD_NUMBER 234 # BUILD_NUMBER should be set to the source control value that 235 # represents the current state of the source code. E.g., a 236 # perforce changelist number or a git hash. Can be an arbitrary string 237 # (to allow for source control that uses something other than numbers), 238 # but must be a single word and a valid file name. 239 # 240 # If no BUILD_NUMBER is set, create a useful "I am an engineering build 241 # from this date/time" value. Make it start with a non-digit so that 242 # anyone trying to parse it as an integer will probably get "0". 243 BUILD_NUMBER := eng.$(shell echo $${USER:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S) 244endif 245