version_defaults.mk revision 1a029f0da23613534a8665525413713a28fa3d43 
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#     PLATFORM_VNDK_VERSION
30#
31
32# Look for an optional file containing overrides of the defaults,
33# but don't cry if we don't find it.  We could just use -include, but
34# the build.prop target also wants INTERNAL_BUILD_ID_MAKEFILE to be set
35# if the file exists.
36#
37INTERNAL_BUILD_ID_MAKEFILE := $(wildcard $(BUILD_SYSTEM)/build_id.mk)
38ifdef INTERNAL_BUILD_ID_MAKEFILE
39  include $(INTERNAL_BUILD_ID_MAKEFILE)
40endif
41
42DEFAULT_PLATFORM_VERSION := PPR1
43MIN_PLATFORM_VERSION := PPR1
44MAX_PLATFORM_VERSION := PPR1
45
46ALLOWED_VERSIONS := $(call allowed-platform-versions,\
47  $(MIN_PLATFORM_VERSION),\
48  $(MAX_PLATFORM_VERSION),\
49  $(DEFAULT_PLATFORM_VERSION))
50
51ifndef TARGET_PLATFORM_VERSION
52  TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION)
53endif
54
55ifeq (,$(filter $(ALLOWED_VERSIONS), $(TARGET_PLATFORM_VERSION)))
56  $(warning Invalid TARGET_PLATFORM_VERSION '$(TARGET_PLATFORM_VERSION)', must be one of)
57  $(error $(ALLOWED_VERSIONS))
58endif
59
60# Default versions for each TARGET_PLATFORM_VERSION
61# TODO: PLATFORM_VERSION, PLATFORM_SDK_VERSION, etc. should be conditional
62# on this
63
64# This is the canonical definition of the platform version,
65# which is the version that we reveal to the end user.
66# Update this value when the platform version changes (rather
67# than overriding it somewhere else).  Can be an arbitrary string.
68
69# When you add a new PLATFORM_VERSION which will result in a new
70# PLATFORM_SDK_VERSION please ensure you add a corresponding isAtLeast*
71# method in the following java file:
72# frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java
73
74# When you change PLATFORM_VERSION for a given PLATFORM_SDK_VERSION
75# please add that PLATFORM_VERSION as well as clean up obsolete PLATFORM_VERSION's
76# in the following text file:
77# cts/tests/tests/os/assets/platform_versions.txt
78PLATFORM_VERSION.PPR1 := P
79
80# These are the current development codenames, if the build is not a final
81# release build.  If this is a final release build, it is simply "REL".
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_VERSION_CODENAME
113  PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
114  ifndef PLATFORM_VERSION_CODENAME
115    # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
116    PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
117  endif
118
119  # This is all of the *active* development codenames. There are future
120  # codenames not included in this list. This confusing name is needed because
121  # all_codenames has been baked into build.prop for ages.
122  #
123  # Should be either the same as PLATFORM_VERSION_CODENAME or a comma-separated
124  # list of additional codenames after PLATFORM_VERSION_CODENAME.
125  PLATFORM_VERSION_ALL_CODENAMES :=
126
127  # Build a list of all active code names. Avoid duplicates, and stop when we
128  # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
129  # that is not included in our build).
130  _versions_in_target := \
131    $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
132  $(foreach version,$(_versions_in_target),\
133    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
134    $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
135      $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
136
137  # This is all of the inactive development codenames. Available to be targeted
138  # in this branch but in the future relative to our current target.
139  PLATFORM_VERSION_FUTURE_CODENAMES :=
140
141  # Build a list of all untargeted code names. Avoid duplicates.
142  _versions_not_in_target := \
143    $(filter-out $(PLATFORM_VERSION_ALL_CODENAMES),$(ALL_VERSIONS))
144  $(foreach version,$(_versions_not_in_target),\
145    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
146    $(if $(filter $(_codename),$(PLATFORM_VERSION_FUTURE_CODENAMES)),,\
147      $(eval PLATFORM_VERSION_FUTURE_CODENAMES += $(_codename))))
148
149  # And convert from space separated to comma separated.
150  PLATFORM_VERSION_ALL_CODENAMES := \
151    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES)))
152  PLATFORM_VERSION_FUTURE_CODENAMES := \
153    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_FUTURE_CODENAMES)))
154
155endif
156
157ifeq (REL,$(PLATFORM_VERSION_CODENAME))
158  PLATFORM_PREVIEW_SDK_VERSION := 0
159else
160  ifndef PLATFORM_PREVIEW_SDK_VERSION
161    # This is the definition of a preview SDK version over and above the current
162    # platform SDK version. Unlike the platform SDK version, a higher value
163    # for preview SDK version does NOT mean that all prior preview APIs are
164    # included. Packages reading this value to determine compatibility with
165    # known APIs should check that this value is precisely equal to the preview
166    # SDK version the package was built for, otherwise it should fall back to
167    # assuming the device can only support APIs as of the previous official
168    # public release.
169    # This value will always be 0 for release builds.
170    PLATFORM_PREVIEW_SDK_VERSION := 1
171  endif
172endif
173
174ifndef DEFAULT_APP_TARGET_SDK
175  # This is the default minSdkVersion and targetSdkVersion to use for
176  # all .apks created by the build system.  It can be overridden by explicitly
177  # setting these in the .apk's AndroidManifest.xml.  It is either the code
178  # name of the development build or, if this is a release build, the official
179  # SDK version of this release.
180  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
181    DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
182  else
183    DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
184  endif
185endif
186
187ifndef PLATFORM_VNDK_VERSION
188  # This is the definition of the VNDK version for the current VNDK libraries.
189  # The version is only available when PLATFORM_VERSION_CODENAME == REL.
190  # Otherwise, it will be set to "current". The ABI is allowed to be changed
191  # only if PLATFORM_VNDK_VERSION == current. Once PLATFORM_VNDK_VERSION is set
192  # to actual version, the ABI for this version will be frozon and emit build
193  # errors if any ABI for the VNDK libs are changed.
194  # After that the snapshot of the VNDK with this version will be generated.
195  #
196  # The version follows PLATFORM_SDK_VERSION.
197  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
198    PLATFORM_VNDK_VERSION := $(PLATFORM_SDK_VERSION)
199  else
200    PLATFORM_VNDK_VERSION := current
201  endif
202endif
203
204ifndef PLATFORM_SECURITY_PATCH
205    #  Used to indicate the security patch that has been applied to the device.
206    #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
207    #  It must be of the form "YYYY-MM-DD" on production devices.
208    #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
209    #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
210      PLATFORM_SECURITY_PATCH := 2018-02-05
211endif
212
213ifndef PLATFORM_BASE_OS
214  # Used to indicate the base os applied to the device.
215  # Can be an arbitrary string, but must be a single word.
216  #
217  # If there is no $PLATFORM_BASE_OS set, keep it empty.
218  PLATFORM_BASE_OS :=
219endif
220
221ifndef BUILD_ID
222  # Used to signify special builds.  E.g., branches and/or releases,
223  # like "M5-RC7".  Can be an arbitrary string, but must be a single
224  # word and a valid file name.
225  #
226  # If there is no BUILD_ID set, make it obvious.
227  BUILD_ID := UNKNOWN
228endif
229
230ifndef BUILD_DATETIME
231  # Used to reproduce builds by setting the same time. Must be the number
232  # of seconds since the Epoch.
233  BUILD_DATETIME := $(shell date +%s)
234endif
235
236ifneq (,$(findstring Darwin,$(UNAME)))
237DATE := date -r $(BUILD_DATETIME)
238else
239DATE := date -d @$(BUILD_DATETIME)
240endif
241
242ifndef BUILD_NUMBER
243  # BUILD_NUMBER should be set to the source control value that
244  # represents the current state of the source code.  E.g., a
245  # perforce changelist number or a git hash.  Can be an arbitrary string
246  # (to allow for source control that uses something other than numbers),
247  # but must be a single word and a valid file name.
248  #
249  # If no BUILD_NUMBER is set, create a useful "I am an engineering build
250  # from this date/time" value.  Make it start with a non-digit so that
251  # anyone trying to parse it as an integer will probably get "0".
252  BUILD_NUMBER := eng.$(shell echo $${USER:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
253endif
254