version_defaults.mk revision eba39713c84bd08e8641490beb9fa80d92524490 
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_JACK_MIN_SDK_VERSION
121  # This is definition of the min SDK version given to Jack for the current
122  # platform. For released version it should be the same as
123  # PLATFORM_SDK_VERSION. During development, this number may be incremented
124  # before PLATFORM_SDK_VERSION if the platform starts to add new java
125  # language supports.
126  PLATFORM_JACK_MIN_SDK_VERSION := o-b1
127endif
128
129ifndef PLATFORM_VERSION_CODENAME
130  PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
131  ifndef PLATFORM_VERSION_CODENAME
132    # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
133    PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
134  endif
135
136  # This is all of the development codenames that are active.  Should be either
137  # the same as PLATFORM_VERSION_CODENAME or a comma-separated list of additional
138  # codenames after PLATFORM_VERSION_CODENAME.
139  PLATFORM_VERSION_ALL_CODENAMES :=
140
141  # Build a list of all possible code names. Avoid duplicates, and stop when we
142  # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
143  # that is not included in our build.
144  _versions_in_target := \
145    $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
146  $(foreach version,$(_versions_in_target),\
147    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
148    $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
149      $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
150
151  # And convert from space separated to comma separated.
152  PLATFORM_VERSION_ALL_CODENAMES := \
153    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_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_SECURITY_PATCH
188    #  Used to indicate the security patch that has been applied to the device.
189    #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
190    #  It must be of the form "YYYY-MM-DD" on production devices.
191    #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
192    #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
193      PLATFORM_SECURITY_PATCH := 2017-09-05
194endif
195
196ifndef PLATFORM_BASE_OS
197  # Used to indicate the base os applied to the device.
198  # Can be an arbitrary string, but must be a single word.
199  #
200  # If there is no $PLATFORM_BASE_OS set, keep it empty.
201  PLATFORM_BASE_OS :=
202endif
203
204ifndef BUILD_ID
205  # Used to signify special builds.  E.g., branches and/or releases,
206  # like "M5-RC7".  Can be an arbitrary string, but must be a single
207  # word and a valid file name.
208  #
209  # If there is no BUILD_ID set, make it obvious.
210  BUILD_ID := UNKNOWN
211endif
212
213ifndef BUILD_DATETIME
214  # Used to reproduce builds by setting the same time. Must be the number
215  # of seconds since the Epoch.
216  BUILD_DATETIME := $(shell date +%s)
217endif
218
219ifneq (,$(findstring Darwin,$(UNAME)))
220DATE := date -r $(BUILD_DATETIME)
221else
222DATE := date -d @$(BUILD_DATETIME)
223endif
224
225ifndef BUILD_NUMBER
226  # BUILD_NUMBER should be set to the source control value that
227  # represents the current state of the source code.  E.g., a
228  # perforce changelist number or a git hash.  Can be an arbitrary string
229  # (to allow for source control that uses something other than numbers),
230  # but must be a single word and a valid file name.
231  #
232  # If no BUILD_NUMBER is set, create a useful "I am an engineering build
233  # from this date/time" value.  Make it start with a non-digit so that
234  # anyone trying to parse it as an integer will probably get "0".
235  BUILD_NUMBER := eng.$(shell echo $${USER:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
236endif
237