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