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