version_defaults.mk revision cd38b8601665e4474ec4536229d3c9b7eba2261f 
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 := OPR1
42MIN_PLATFORM_VERSION := OPR1
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.OPR1 := O
83
84# These are the current development codenames.
85PLATFORM_VERSION_CODENAME.OPR1 := O
86PLATFORM_VERSION_CODENAME.PPR1 := P
87
88ifndef PLATFORM_VERSION
89  PLATFORM_VERSION := $(PLATFORM_VERSION.$(TARGET_PLATFORM_VERSION))
90  ifndef PLATFORM_VERSION
91    # PLATFORM_VERSION falls back to TARGET_PLATFORM_VERSION
92    PLATFORM_VERSION := $(TARGET_PLATFORM_VERSION)
93  endif
94endif
95
96ifndef PLATFORM_SDK_VERSION
97  # This is the canonical definition of the SDK version, which defines
98  # the set of APIs and functionality available in the platform.  It
99  # is a single integer that increases monotonically as updates to
100  # the SDK are released.  It should only be incremented when the APIs for
101  # the new release are frozen (so that developers don't write apps against
102  # intermediate builds).  During development, this number remains at the
103  # SDK version the branch is based on and PLATFORM_VERSION_CODENAME holds
104  # the code-name of the new development work.
105
106  # When you change PLATFORM_SDK_VERSION please ensure you also update the
107  # corresponding methods for isAtLeast* in the following java file:
108  # frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java
109
110  # When you increment the PLATFORM_SDK_VERSION please ensure you also
111  # clear out the following text file of all older PLATFORM_VERSION's:
112  # cts/tests/tests/os/assets/platform_versions.txt
113  PLATFORM_SDK_VERSION := 25
114endif
115
116ifndef PLATFORM_JACK_MIN_SDK_VERSION
117  # This is definition of the min SDK version given to Jack for the current
118  # platform. For released version it should be the same as
119  # PLATFORM_SDK_VERSION. During development, this number may be incremented
120  # before PLATFORM_SDK_VERSION if the plateform starts to add new java
121  # language supports.
122  PLATFORM_JACK_MIN_SDK_VERSION := o-b1
123endif
124
125ifndef PLATFORM_VERSION_CODENAME
126  PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
127  ifndef PLATFORM_VERSION_CODENAME
128    # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
129    PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
130  endif
131
132  # This is all of the *active* development codenames. There are future
133  # codenames not included in this list. This confusing name is needed because
134  # all_codenames has been baked into build.prop for ages.
135  #
136  # Should be either the same as PLATFORM_VERSION_CODENAME or a comma-separated
137  # list of additional codenames after PLATFORM_VERSION_CODENAME.
138  PLATFORM_VERSION_ALL_CODENAMES :=
139
140  # Build a list of all active code names. Avoid duplicates, and stop when we
141  # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
142  # that is not included in our build).
143  _versions_in_target := \
144    $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
145  $(foreach version,$(_versions_in_target),\
146    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
147    $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
148      $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
149
150  # This is all of the inactive development codenames. Available to be targeted
151  # in this branch but in the future relative to our current target.
152  PLATFORM_VERSION_FUTURE_CODENAMES :=
153
154  # Build a list of all untargeted code names. Avoid duplicates.
155  _versions_not_in_target := \
156    $(filter-out $(PLATFORM_VERSION_ALL_CODENAMES),$(ALL_VERSIONS))
157  $(foreach version,$(_versions_not_in_target),\
158    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
159    $(if $(filter $(_codename),$(PLATFORM_VERSION_FUTURE_CODENAMES)),,\
160      $(eval PLATFORM_VERSION_FUTURE_CODENAMES += $(_codename))))
161
162  # And convert from space separated to comma separated.
163  PLATFORM_VERSION_ALL_CODENAMES := \
164    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES)))
165  PLATFORM_VERSION_FUTURE_CODENAMES := \
166    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_FUTURE_CODENAMES)))
167
168endif
169
170ifeq (REL,$(PLATFORM_VERSION_CODENAME))
171  PLATFORM_PREVIEW_SDK_VERSION := 0
172else
173  ifndef PLATFORM_PREVIEW_SDK_VERSION
174    # This is the definition of a preview SDK version over and above the current
175    # platform SDK version. Unlike the platform SDK version, a higher value
176    # for preview SDK version does NOT mean that all prior preview APIs are
177    # included. Packages reading this value to determine compatibility with
178    # known APIs should check that this value is precisely equal to the preview
179    # SDK version the package was built for, otherwise it should fall back to
180    # assuming the device can only support APIs as of the previous official
181    # public release.
182    # This value will always be 0 for release builds.
183    PLATFORM_PREVIEW_SDK_VERSION := 0
184  endif
185endif
186
187ifndef DEFAULT_APP_TARGET_SDK
188  # This is the default minSdkVersion and targetSdkVersion to use for
189  # all .apks created by the build system.  It can be overridden by explicitly
190  # setting these in the .apk's AndroidManifest.xml.  It is either the code
191  # name of the development build or, if this is a release build, the official
192  # SDK version of this release.
193  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
194    DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
195  else
196    DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
197  endif
198endif
199
200ifndef PLATFORM_SECURITY_PATCH
201    #  Used to indicate the security patch that has been applied to the device.
202    #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
203    #  It must be of the form "YYYY-MM-DD" on production devices.
204    #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
205    #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
206      PLATFORM_SECURITY_PATCH := 2017-04-05
207endif
208
209ifndef PLATFORM_BASE_OS
210  # Used to indicate the base os applied to the device.
211  # Can be an arbitrary string, but must be a single word.
212  #
213  # If there is no $PLATFORM_BASE_OS set, keep it empty.
214  PLATFORM_BASE_OS :=
215endif
216
217ifndef BUILD_ID
218  # Used to signify special builds.  E.g., branches and/or releases,
219  # like "M5-RC7".  Can be an arbitrary string, but must be a single
220  # word and a valid file name.
221  #
222  # If there is no BUILD_ID set, make it obvious.
223  BUILD_ID := UNKNOWN
224endif
225
226ifndef BUILD_DATETIME
227  # Used to reproduce builds by setting the same time. Must be the number
228  # of seconds since the Epoch.
229  BUILD_DATETIME := $(shell date +%s)
230endif
231
232ifneq (,$(findstring Darwin,$(UNAME)))
233DATE := date -r $(BUILD_DATETIME)
234else
235DATE := date -d @$(BUILD_DATETIME)
236endif
237
238ifndef BUILD_NUMBER
239  # BUILD_NUMBER should be set to the source control value that
240  # represents the current state of the source code.  E.g., a
241  # perforce changelist number or a git hash.  Can be an arbitrary string
242  # (to allow for source control that uses something other than numbers),
243  # but must be a single word and a valid file name.
244  #
245  # If no BUILD_NUMBER is set, create a useful "I am an engineering build
246  # from this date/time" value.  Make it start with a non-digit so that
247  # anyone trying to parse it as an integer will probably get "0".
248  BUILD_NUMBER := eng.$(shell echo $${USER:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
249endif
250